OpenRTB Integration Process

This document includes the necessary information for supply partners to review, plan, and execute a new OpenRTB integration, or migrate from a custom SSP protocol integration to OpenRTB standard, in a self-paced fashion.

Prerequisite Checklist

*NOTE: It is mandatory to use the Customer Support Portal for communication to complete each step of the integration process. If you do not already have a customer support portal account, please visit the Login page, proceed as a Guest, and request a new user registration.

  1. Open a ticket with our support team to confirm the following information:
    1. Global auction timeout limits, QPS limits and data center IPs closest to the Xandr datacenter regions: US-east, US-west, EMEA and APAC.
    2. Member seat ID and if not requested yet, new member seat creation and API login credentials for Xandr's API.
    3. Endpoints for incoming bid requests, and if not requested yet, new endpoint creation on Xandr.
    4. Usersync pixel in order to map your user IDs to Xandr user IDs, and if not requested yet, new usersync pixel activation.
  2. Review the documentation outlined below and discuss any open questions with our support team:
    1. OpenRTB Specs
    2. FAQ - Integration Process


NOTE: Prerequisite checks are only complete after the contract is signed and member ID is created. Prior to that, only point 1a. can be processed. However, until the contract is countersigned, we'd still love to kick off the conversation in Customer Portal with your integration team so that you can get familiar with the customer case process and get your technical questions addressed right away!

Integration Steps

Step 1: Self-guided API/UI training and creation of publisher and placement objects (Estimated time: 7-10 days)

*NOTE: In order to provide transparency to our buyers and improve our optimization, we require our partners to break out their inventory by publisher. For more information regarding our inventory structure standards please visit our wiki page Use the API to Synchronize Your Inventory Structure. 

*NOTE: The code field is required for all external sellers at both the publisher and placement levels and is highly recommended for all other sellers to ensure that your inventory is as granular as possible so that it can be investigated accurately for quality issues, and specifically for domain detectability. This step will help you to split your inventory into highly detectable and less detectable tags, allowing you to isolate the impacts of non-detectable domains on the rest of your inventory's viability.

*NOTE: In order to create or edit publishers in the UI or the API, you have to declare the Inventory Relationship.  The requested information is basic business information about how the inventory is accessed and will be used to support Xandr's inventory quality efforts. For a complete list of fields and their usage requirements, please refer to the Publisher Service documentation.

Step 2: OpenRTB bid request endpoint testing (Estimated time: 7-10 days)

Do not leave &test=1 in your production traffic, we will not log those impressions on our platform. &test=1 is intended to safely test OpenRTB protocol format issues. Make sure to remove &test=1 as soon as you start sending test inventory to Xandr.

*NOTE: MEMBER_ID and MEMBER_ALIAS should be substituted with your individual partner member ID and alias. 

Step 3: Discrepancy checks and OpenRTB requirement validation 100QPS (Estimated time: 7-10 days)

Final OpenRTB requirement validation 100%

Notify your Xandr contact about the completion of the self-paced integration/migration; your contact will initiate the final OpenRTB requirement validation tests and provide you with final results and feedback.