Partner API

Data overview

In order to generate ads, CitrusAd needs to ingest product, customer, and order data from the retailer’s site. Once the data is populated by the retailer, it is stored, processed, and updated within the CitrusAd platform.

To automate the process of downloading and updating data, CitrusAd and the retailer agree on the format and structure of the data, as well as the protocol for communication between the retailer’s site and the CitrusAd platform.

This section describes the constraints on the feeding in of three types of data: product, customer, and order.

Syncing options

You may want to sync your data via API or by syncing files, depending on your integration requirements. CitrusAd supports both types of syncing. For more information, please visit the relevant page below:

Sync data via file or API?

The decision on how to sync data is ultimately up to the retailer, as both options have their benefits and drawbacks. Larger retailers often prefer to sync via file as it aligns better with resource capabilities and only requires files to be uploaded on a daily basis.

🚧

CitrusAd recommends syncing data via file, as it’s easier to troubleshoot and resolve. If retailer file issues occur, previous catalog files can be reinstated until the issue is fixed.

Syncing data via API

Pros:

  • Faster data ingestions and updates
  • Self sufficient.

Cons:

  • Data must be batched
  • Higher difficulty in troubleshooting
  • Cannot roll back to previous updates.

Syncing data via File

Pros:

  • Single file supported per data type supported, as opposed to batching
  • Can be synced at preferred timing intervals (daily is recommended)
  • Different protocol support (GCS, SFTP, SCP, HTTPS)
  • Easier to navigate when troubleshooting
  • Can roll back to previous files.

Cons:

  • Data is updated once ingested
  • Delta updates are not supported.

Syncing data via file protocols

When syncing data via file, additional protocols and practices need to be adhered to.

Please visit the Syncing data via file protocols page for more information.

📘

AWS S3: no longer supported

Unfortunately, CitrusAd no longer supports synchronising files via AWS. Please contact your Technical Account Manager to discuss if you need assistance using GCS.