Here you can find our API documentation and our integration guide.
The Search API implements a REST interface. JSON is returned by all API responses, including errors. HTTP response status codes are used to designate success and failure.
All the urls in this document are described as being served from the domain {SEARCHDOMAIN}. Your Tappa representative will advise you on the ideal domain to use for the geo/traffic volume.
In order to use the services provided by the Search API you will need at least a ClientID, an Authorization Token and one or more campaign identifiers. Your Tappa Search technical contact will be able to provide you with these credentials.
Typically the API endpoints require the ClientID and the applicable CampaignID to be sent as part of the json body of the post, combined with an Authorization header containing the Authorization Token.
The Search API makes available both a test and production environment. Requests to the test system return representative data from a sample dataset and campaigns running in the test environment are not monetized.
We will provide you with one or more campaigns to use in each environment. Campaigns can either be defined as being specific to a country code, where they will only return results to users making requests from ip addresses that geo-locate to that country code, or defined to match results to the country code of the caller. Campaigns represent the root level of reporting granularity so if you want to differentiate between traffic across several domains we would recommend using a different campaign for each.
The Search API provides a set of services that allow you to provide your customers with links to context relevant content, and for traffic to those destinations to be monetized.
Content types available through the API include brands, products, animated gifs, sticker packs and video. A set of served content types is configured per campaign, so for example you could opt to return just brands for one campaign and in another return products and relevant gifs.
To supplement the API, we also provide a javascript product display component (PLA) as a quick means of integrating results into a web page.
Our direct-to-advertiser service is our simplest offering, providing a fixed campaign that you can very simply integrate. After discussion with a Tappa Search representative to determine a fixed set of brands that you would like to run, we will provide you with one or more configuration triplets, in the following format:
[
{
"name": "Nike Official Site. Nike.com",
"link": "<https://track>.{SEARCHDOMAIN}/link/2378fh27832h7h",
"creatives":
{
"logo": "<https://assets.tappa.com/mobicast/image/upload/logo/nike.com>",
"favicon": "<https://assets.tappa.com/mobicast/image/upload/favicon/nike.com/144>"
}
}
]