REST API Adskeeper for publishers

* Please note that all API requests must be performed via HTTPS.

The main provisions of REST API

REST API allows you to integrate external applications with Adskeeper online  

advertising system.

API provides the ability to retrieve, add, and modify the data. Practically each object in Adskeeper (whether it's a client, an advertising company, a teaser, etc.) can be controlled by API. Adskeeper REST API Request is an HTTP request which with the help of the ways in the URL the object to perform the action is specified, and  with the help of parameters the necessary data is passed. Adskeeper API is a "RESTful  Web API". The API uses the following REST commands:

• GET
• PUT
• PATCH
• POST
• DELETE

The query parameters are case sensitive.

These commands correspond to certain actions within the Adskeeper system. Get an item or a collection of items (for example, a list of advertising campaigns): 

In general, the query looks like this:
https://api.adskeeper.co.uk/v1/module/controller/action?parameter_1=value_of_parameter_1&parameter_2=value_of_parameter_2&parameter_3=value_of_parameter_3

Identification

For identification the Adskeeper REST API uses a unique token consisting of 32 characters which is passed in the client’s request Authorization header. To obtain a valid token client should use a special API function.

REST API answer

In response to a request to the REST API server always returns the HTTP response with a status code, depending on the result of the query.

Format of the returned data

The returned data can be formatted as JSON, or XML.  The default format is JSON. The request header is used to specify the format in which the data is  

returned. The client sends an Accept header, which indicates desired response format:  

Accept: application / xml  

or  

Accept: application / json

Description of the response format is sent in the response header Content Type. The data returned is the answer is a JSON string, which generally looks as follows: 

{
    "element_1":"value_of_element_1",    
    "element_2":"value_of_element_2", 
    "element_3":{
         "property_1_of_element_3":"value_of_property_1_of_element_3",       
         "property_2_of_element_3":[
               "value_1_of_property_2_of_element_3",
               "value_2_of_property_2_of_element_3"
         ]       
     }    

  . . . .  
}

If an error has occurred during the execution of the query   the description corresponding to the error is returned, such as:

{ "errors": [ "[_error_description_]" ] }

Working with widgets

Custom reports

Transferred parameters (required parameters are marked with asterisk *):