Getting Started

Status: Running
Planned Service Interruptions: None

Overview

OI API enables advertisers to view, add and update ads displayed in the Opt-Intelligence exchange. It also enables websites and mobile apps to create ad placements. Ads are used to facilitate sign-ups for an advertiser’s marketing program and can be targeted to various demographics and geo-locations. Placements are used to monetize desktop and mobile traffic with ad revenue.




Glossary

Terms Description
Advertiser
Client Users can have multiple Advertisers. Each Advertiser can have multiple Offers.
Approval Queue
All new Offers are added to the Approval Queue. OI employees will review new Offers and then remove them from the queue.
Autoresponder
An automatic email sent out to the User at time of Opt-in
Client User
An Advertiser Client User displays ads on the Opt-Intelligence Ad Network while a Publisher Client User displays these ads on their site or mobile app.
Cost Per Lead (CPL)
The price a Client User pays for each Lead
Data Points
Information about a User that is collected upon Opt-in
Data Transfers
Data Transfers are used to send Leads to a Client User
Lead
Information sent to an Advertiser when a User conducts an Opt-in
Offer
Offers are used to encourage sign-ups for a company's product or service and can be targeted to various demographics and locations
Offer Creative
The Image and Copy that make up an Offer
Opt-in
When a user voluntarily elects to receive more information about a good or service on the Opt-Intelligence Ad Network
Placement
A place on a website or mobile app where ads are shown
Publisher
Client Users can have multiple Publishers. Each Publisher can have multiple Placements.
User
A person who interacts with an ad on the Opt-Intelligence Ad Network.
Validation
Following an Opt-in, this process may deem that Opt-in invalid (due to a bad email address or a User unsubscribe).



REST API

Endpoint

All requests must be made with an SSL (https) connection.

https://oiapi.com/v1/

Sending & Receiving Data

Currently our List Growth API only supports serialized JSON objects. This will give you the ability to build a native object, serializing it as JSON, and then pass that to us. We will then return a serialized JSON object.




Authentication

The API utilizes a basic http access authentication.

It should be passed as username:password, 64 bit encoded.

Example Curl Command for authentication:

curl --header "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" https://oiapi.com/v1/advertisers/