Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Once the images' generation has been automated by Boxalino, the API links can be integrated in the newsletter templates:

  1. image source link : the link to the recommended content`s image on your FTP

    https://track.bx-cloud.com/p13n-rest/ img?user=<account-name>&indexId=<account-name>&apiKey=<newsletter-api-key>&profileId=*|CUSTOMERID|*&customerId=*|CUSTOMERID|*&choiceId=newsletter&lang=de&offset=0&rc_campaign=<custom-campaing-code>&rc_cuid=*|CAMPAIGN_UID|*

  2. content redirect link : the link to redirect the user on click to the content on your e-shop (product, blog, campaign, etc)

    https://track.bx-cloud.com/p13n-rest/redirect?user=<account-name>&indexId=<account-name>&apiKey=<newsletter-api-key>&profileId=*|CUSTOMERID|*&customerId=*|CUSTOMERID|*&choiceId=newsletter&lang=de&offset=0&rc_campaign=<custom-campaing-code>&rc_cuid=*|CAMPAIGN_UID|*

The green data is provided by Boxalino

The red data must be provided by your newsletter engine (the above are Mailchimp variables); :

  • the profileId and customerId can not be empty; the value “0” (zero) or “not-set” must be the default configured option in your system

The orange content must be adapted per your strategy (the choice WPO and the offset);

  • the

...

  • choiceId is the widget (WPO) for your content (products, blogs, banners, etc)

...

  • the offset is the

...

  • recommended content number, starting from 0 (the 1st recommended content for the customer

...

  • )

The purple and blue content are extra-parameters which can be added to your newsletter in order to link them to pre-defined campaigned rules within Boxalino system:

  • rc_campaign is used if the optimization rule is linked to the campaign name (Campaign Correlation Promoter rule)

  • rc_cuid is used if the optimization rule is linked to the Mailchimp/marketing tool campaign ID (CUID Correlation Promoter rule)

For example, in your recommendation block within your newsletter template, a product recommendation will look like:

 

Code Block
languagehtml
<a href="https://track.bx-cloud.com/p13n-rest/
imgRedirect?user=<account-name>&indexId=<account-name>&apiKey=<newsletter-api-key>&profileId=*|CUSTOMERID|*&customerId=*|CUSTOMERID|*&choiceId=newsletter&lang=de&offset=0&rc_campaign=<custom-campaing-code>" target="_blank">
<img src="https://track.bx-cloud.com/p13n-rest/
img?user=<account-name>&indexId=<account-name>&apiKey=<newsletter-api-key>&profileId=*|CUSTOMERID|*&customerId=*|CUSTOMERID|*&choiceId=newsletter&lang=de&offset=0&rc_campaign=<custom-campaing-code>" />
</a>

 

Additionally, if you want to check the image stored on your own servers, you can use the following link, with the imgRedirect endpoint:

https://track.bx-cloud.com/p13n-rest/imgRedirect?user=<account-name>&indexId=<account-name>&apiKey=<newsletter-api-key>&profileId=*|CUSTOMERID|*&customerId=*|CUSTOMERID|*&choiceId=newsletter&lang=de&offset=0

Status