Integration Workflow

Martailer is always integrated via backend. Same integration principles apply regardless of you your frontends: web, mobile app.

Integration Process

1. Create a store(s) using /stores endpoint. Sores contextualise product catalog i.e. same SKU could be available in one store and out of stock in another.
2. Provide Martailer access to your product catalog via /sync/products endpoint.
3. (Optional) Upload order history. It is used to build ad-targeting models.
4. Martailer ingests product catalog, and order history (if provided).
5. Create some test campaigns using Martailer's campaign manager.
6. On every page load make a PUT request to /log/events endpoint to report a pageview event. Events are used to build visitor profiles and serve them personalized ads.
7. Make a POST request to /combined/ads endpoint, providing necessary parameters such as `placement`, `visitorId`, 'numberOfAds'.
8. Martailer returns a set of ads in the JSON list format. Single response may contain multiple ads and multiple ad formats e.g. both sponsored products and banners.
9. Your backend blends received ads with your content.
10. Your backend sends combined information to your frontend.
11. When ads are loaded into the visible part of the visitor's screen, you should report the impression event of one or multiple ads to Martailer by making a PUT request to /log/events endpoint providing parameters such as `event`, `visitorId`, `customerId' and a list of `adId`s for which you are reporting an impression.
12. When ad is clicked by your visitor, you report the click by making a PUT request to /log/events endpoint providing parameters such as `visitorId`, `customerId' and an `adId` of an ad for which you are reporting a click.
13. When order(s) occur, make sure to upload them by making POST request to /log/orders endpoint. Please note orders may be reported either in batches or one order at a time.