PRODUCT

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Follow

Overview

The Amazon Ad Server (AAS) API enables clients and partners to integrate with AAS and data in their own independently built applications. The API provides programmatic access and control to advertising accounts so partners can create campaigns, manage and traffic ads, and retrieve analytics and reporting data.

Making API Requests

AAS API provides RESTful API access over an HTTPS connection. AAS does not redirect requests to HTTP. You can make all Amazon API requests through the base URL:

  • https://adapi.sizmek.com/sas/

Keep in mind the following points when making API requests:

  • All AAS entities and responses are available in JSON format only.

  • All API-related identifiers and parameters are strings with UTF-8 encoding.

  • Requests return informative error messages based on HTTP standards. For more information, see API Validation Error Messages.

  • You cannot exceed 10 simultaneous, active, API sessions with the same user ID.

  • API parameters are case-sensitive.

Setting Up Your Account

Requests to the AAS API are protected by basic authentication. You use a specific API username and password to get an access token for API requests.

API environments include the following:

  • Sandbox API: It is recommended to use this environment to perform tests before going live.

    https://adapi.uat.sizmek.com/sas

  • Production API: Use this environment once testing is complete.

    https://adapi.sizmek.com/sas

Procedure
  1. Contact your AAS client services manager, and request an API user under your existing account.

  2. You should receive an email message that includes a username and password for the sandbox environment. Use these credentials to perform tests, for example, start to test endpoints by calling specific API methods.

    Note

    Note:

    AAS passwords expire every 120 days for API users. If your password has expired, an error message will be displayed when you try to log in. Account administrators can reset passwords for other users under the same account.

    Make sure that you include your API key in each call. For more information about authentication, see Authentication. The login URL to this environment is:

    https://adapi.uat.sizmek.com/sas/login/login

    Important

    Important: You cannot use your API credentials to log into AAS. These credentials are used exclusively for submitting API requests.

  3. Once testing is complete, you can request a username and password to access the production environment. For more information about test plans, see Amazon Ad Server API Test Plan.

  4. Use the assigned API username and password to log in to the production environment and generate a Amazon session token. The login URL to this environment is:

    • https://adapi.sizmek.com/sas/login/login/

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments