AdQuick API

Overview

AdQuick provides a REST-based API that conforms to standard HTTP best practices. The API returns JSON-encoded responses.

Authorization

During the onboarding process we will provide you with a Partner ID. For authorization, all requests should include that data in the headers as follows:

Code
 Headers: {
   ... other headers,
   "Authorization": "Bearer {your_bearer_token}",
   "X-PARTNER-TOKEN": "{your_partner_token}"
 }

Base URL

The base url for all requests is https://api.adquick.com/v1/

All API requests must be made over https.

Errors

HTTP codes in the 2xx range indicate success. Codes in the 4xx range indicate a received, but invalid request. Codes in the 5xx range indicate an error with AdQuick's servers.

HTTP Status Code Summary:

200 – OK Success

400 – Bad Request

401 – Unauthorized

402 – Request Failed

403 – Forbidden

404 – Not Found

429 – Too Many Requests

Pagination

All index requests are paginated. They will include current_page and total_pages as part of the response body. The default number of records per page is 10.

To change pages pass a current_page or page param in the query string.

To change the number of items per page pass a per_page param in the query string.

Code
 {
   "current_page": 1, #=> the current page
   "total_pages": 7, #=> the total number of pages
   "records": [ ... ], #=> an array of the data requested
   "total_entries: 200, #=> number of total results
   "next_page": 8, #=> the value for next page
   "prev_page": 6, #=> the value for previous page
 }

Rate Limit

The default rate limit is 5 requests per second. The server will respond with HTTP code 429 if you've surpassed the rate limit.