Before you start

Before you can start requesting ads, you will need sandbox access, your team ID and API key, and active campaigns.

Sandbox access

To integrate with CitrusAd, you will need a sandbox created on your behalf. Your Technical Account Manager will work with you on this, and provide you with access once it is created.

Should you not have access, contact your Technical Account Manager, or contact CitrusAd via our Service Desk

Your team ID and API key

To sync products and interact with our API, you will need your retailer team's ID, and your API key. Once logged into your retailer team, click the dropdown menu in the top right and click Integration Settings

15421542

Your team ID is displayed here, which is the Team ID to use where required in API calls. This value will change depending on whether you are in your sandbox or production environment.

33603360

Click the API Key option in the secondary menu - you will see your secret API key is hidden.

33603360

To retrieve your secret API key, click the 'show' button, and copy it. This is the API key to use in API calls. This value will change depending on whether you are in your sandbox or production environment.

Active campaigns

For CitrusAd to return ads, active and approved campaigns need to be created in your sandbox. You will need to synchronise your catalog with at least one product prior to creating campaigns.

View how to make campaigns in CitrusAd's Help Centre.