The Adsecurity API is organized around REST and uses built-in HTTP features. The main host for all requests is https://api.adsecurity.io and all requests and responses are formatted in JSON including errors.

All requests to the Adsecurity API must be authenticated using an API key. To authenticate, add a API-KEY header to your request that contains your API Key.

• For network administrators you can create individual API keys and find your API keys under Organization > API Access in Adsecurity.
• For all users you can use your own API key by going to Profile > Security > Enable API Access.

For example:

curl -H "API-KEY: <YOUR-API-KEY>" -H "Content-Type: application/json" --url https://api.adsecurity.io/api/v2/publisher-view/654321abcd/offers

All requests require API-KEY and Content-Type in the header. Requests made without authentication will fail.

When submitting data to a resource via POST, or PATCH, you must submit your payload in JSON.

{
"property" : "value"
}

All responses are returned in JSON format as specificed in the Content-Type header. Conventional HTTP response codes are used by the API to indicate the success or failure of an API request. Codes in the 2xx range indicate success whereas codes in the 4xx or 5xx range indicate failure.

JSONAPI Response

You are also able to use jsonapi specification to modify the GET response as follows:

Filter:

To filter the resul you can simply add filter in the url query params: ?filter[type]=this-type&filter[name]=this-name. Plus, you also can do a text search by having ?query=<keyword> in GET methods.

Fields:

To return specific fields you can add fields in the url query params like: fields=id,name

Sorting:

You can sort the result by adding sort query params like sort=-type,name. - will act for descending

Pagination:

To paginate the result you need to provide page query param like page[number]=1&page[size]=8

Response Table