About EIQI

Equativ Inventory Qualification Infrastructure (EIQI) is Equativ’s global solution for semantic contextual targeting: data providers use EIQI to synchronize their data with Equativ. Once synchronized, the according semantic contextual segments become available to target deals/campaigns/line items in Equativ’s supply and demand solutions (Equativ Monetization Platform, Equativ Buyer Connect, Media Buying Module, etc.)

EIQI API integration process for data providers

As a data provider, you must follow the process below to integrate with the Equativ Inventory Qualification Infrastructure (EIQI):

• Sign the contractual agreements with Equativ, if applicable.
• Fill out Equativ’s onboarding form for audience data providers.
• If you plan to use the API integration, you will need to provide your endpoints to Equativ, as explained in EIQI API integration: URL/bundle categorization
• Obtain a sandbox account. Your account manager at Equativ will request the account parameters and provide you with the credentials to develop and test your API implementation in Equativ’s sandbox environment.
• Perform tests in the sandbox account:
  • Use your sandbox credentials to test the API.
  • Perform unit tests and low-volume streaming tests only, as the sandbox environment is not designed to handle high, production-level volumes.
  • Test token management by pushing low volumes of segments and categorization data to verify if integration is successful.
  • Perform short runs to test the process of uploading long-running updates.
• Validate sandbox - contact your account manager and technical contacts at Equativ to get support and validate your sandbox testing.
• Obtain a production account. Once validated, request the production credentials from your account manager.
• Production test:
  • Notify your Equativ contacts about your testing strategy and volumes.
  • Once authorized by Equativ's infrastructure team, proceed with pushing samples of your production data to production endpoints. Then, check with your Equativ contacts regarding volumes and results.
• Activate the integration:
  • Notify your Equativ contacts about your sync strategy and volumes.

Once authorized by Equativ's infrastructure team, proceed to full production mode and begin pushing and activating the segments you plan to use.

Swagger UI

The Swagger UI provides documentation for all operations and includes a request composer for building and testing API requests.

Available Swagger UI environments:

• Swagger - staging environment
• Swagger - production environment

Relevant endpoints

Login endpoint

Taxonomy endpoints

Authentication

To interact with the EIQI API, you must first log in using the credentials client_id and client_secret. Both are provided by Equativ once you sign your contract and are registered as a new data provider in Equativ’s system.

Once logged in, retrieve the authentication token to complete the authentication. When successfully authenticated, you can proceed to uploading segments and retrieving data.

Step 1 - Log in to the EIQI platform

Use the Login endpoint /api/v2/login to log in to the EIQI platform, using your credentials:

• username (client_id, as obtained from Equativ at contract signature)
• password (client_secret, as obtained from Equativ at contract signature)
• application name.

Example credentials:

{
 "username": "user1",
 "password": "Password12345",
 "application": "my-application"
}

Step 2 - Retrieve authentication token

After passing your credentials in the request body of the Login endpoint, retrieve the authentication token "access_token" from the response body.

Example response body containing the authentication token ("access_token")

{   
  "application": "my-application",  
  "access_token": "5|FrQoVRY160GVV1uXPrrrpz4K2FFae9E5RQy4beuf",   
  "token_type": "Bearer",   
  "expire_at": 1678697366
}

Step 3 - Authorization with authentication token

With the authentication token, you are now authorized to interact with the API.

Example authentication token used in Swagger’s “Available authorizations” menu: