Citrus Developer Hub

Citrus Developer Hub

Welcome to the Citrus API Docs developer hub. You'll find comprehensive guides and documentation to help you start working with Citrus API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    


Overview of Citrus platform

What Citrus Offers

Citrus makes it possible for your retail e-commerce website to offer product ads and banner ads to manufacturers, thereby increasing retailer revenue. This is done with the "Citrus API".

The Citrus API makes it possible for you (the retailer) to place advertisements on your e-commerce website based on parameters that you set. After you define the slots on your websites in which advertisements are placed, the slots become available for manufacturers to bid on. You (the retailer) determine which items in your catalog you want to advertise, and Citrus makes it possible for manufacturers to bid on the opportunity to advertise those items.

Citrus offers retailers the opportunity to offer manufacturers the opportunity to bid on prime placement on the retailers' e-commerce websites.

How Citrus Works

The Citrus API is organized around REST. The Citrus API has predictable, resource-oriented URLs and uses HTTP response codes to indicate API errors. This API uses built-in HTTP features such as HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.

Authentication to the Citrus API is handled through the use of API keys. These are used during communication between your backend and the Citrus API.

The Citrus API supports uploading products, catalogs, catalog products, customers, and order information. This data is used in the generation of ads. You can use the Citrus API to request ads and to report on user interactions with those ads.

Citrus API System Diagram