Introduction
Fundamental concepts of AdManage’s API.
Base URL
AdManage’s API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.
The Base URL for all API endpoints is:
Authentication
Authentication to AdManage’s API is performed via the Authorization header with a Bearer token. To authenticate, you need to include the Authorization header with the word Bearer
followed by your API key in your requests like so:
Here are examples of how to authenticate with AdManage’s API in different programming languages:
Learn more about how to get your API key.
Error Handling
AdManage API returns machine readable error codes, human readable error messages and a link to the docs for more information.
Here is how an error response looks like:
Here is a list of all error codes AdManage API returns:
bad_request
bad_request
- Status: 400
- Problem: The request is malformed, either missing required fields, using wrong datatypes, or being syntactically incorrect.
- Solution: Check the request and make sure it is properly formatted.
unauthorized
unauthorized
forbidden
forbidden
- Status: 403
- Problem: The server understood the request, but is refusing to fulfill it because the client lacks proper permission.
- Solution: Make sure you have the necessary permissions to access the resource.
not_found
not_found
- Status: 404
- Problem: The server has not found anything matching the request URI.
- Solution: Check the request and make sure the resource exists.
conflict
conflict
- Status: 409
- Problem: Another resource already uses the same identifier. For example, workspace slug must be unique.
- Solution: Change the identifier to a unique value.
invite_expired
invite_expired
- Status: 410
- Problem: The invite has expired.
- Solution: Generate a new invite.
unprocessable_entity
unprocessable_entity
- Status: 422
- Problem: The server was unable to process the request because it contains invalid data.
- Solution: Check the request and make sure input data is valid.
rate_limit_exceeded
rate_limit_exceeded
- Status: 429
- Problem: The request has been rate limited.
- Solution: Wait for a while and try again.
internal_server_error
internal_server_error
- Status: 500
- Problem: The server encountered an unexpected condition that prevented it from fulfilling the request.
- Solution: Try again later. If the problem persists, contact support.
Pagination
AdManage’s API supports pagination. This is useful when you have a large number of resources and you want to retrieve them in smaller chunks.
These list API methods share a common set of parameters that allow you to control the number of items returned and the page number. For example, you can:
Parameters
The page number to retrieve. By default, the first page is returned.
The number of items to retrieve per page. The default value varies by endpoint. Maximum value is 100.
The field to sort the results by.
The order to sort the results by. Can be asc
or desc
.
Example
The following example demonstrates how to retrieve the first page of 10 ad copy templates: