Akamai APIs API Documentation

Contract API

Number of APIs: 5

Use the Contract API to access details on your organization's Akamai contracts, including associated products and reporting groups contributing to the billing system.

Note: Contracts are important low-level objects on which other services depend. You will need them, for example, when working with the Billing or Invoicing API.

Authentication

Create an authentication credential that contains the client token and client secret required to authenticate Akamai API requests.

Navigate to the Identity and Access Management section of Akamai Control Center and click Create API Client.

Note: If you don't have access to the Identity and Access Management tool, contact your local Akamai Control Center admin or your Akamai account team for assistance.

Click Quick and then Download in the Credentials section.

Note: If you need to refine access levels or permissions, see Create a client with custom permissions.

Open the downloaded file with a text editor and add [default] as a header above all text.

  [default]
  client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
  host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
  access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
  client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj

Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Integration methods

You can use this API collection in these integration methods: - API

1. Contracts - List contracts

GET https://{{host}}/contract-api/v1/contracts/identifiers

Get the list of contracts that a user has access to.

2. Products - List products per contract

GET https://{{host}}/contract-api/v1/contracts/:contractId/products/summaries

Get the IDs and names of the products associated with a contract for the time frame selected.

3. Products - List products per reporting group

GET https://{{host}}/contract-api/v1/reportingGroups/:reportingGroupId/products/summaries

Get the IDs and names of the products associated with the reporting group for the time frame selected. To run this operation, your user account needs the CPCode Rep Group role. To add this role, use the Identity and Access Management application. When a request is successful, it may return either a 200 or a 300 response. The API returns a 200 (OK) response when the CP code reporting group is associated with only one contract. You'll receive a 300 Multiple Choices response when the request returns a list of matching contracts because the CP code reporting group is associated with multiple contracts. To retrieve product information when you receive a 300 response code, make a new GET request to the hyperlinks provided in the response.

4. Reporting groups - List CP code reporting groups

GET https://{{host}}/contract-api/v1/reportingGroups

Get the IDs of the Content Provider (CP) reporting groups that you have access to along with their names. To run this operation, your user account needs the CPCode Rep Group role. To add this role, use the Identity and Access Management application.

5. Reporting groups - List CP code reporting group IDs

GET https://{{host}}/contract-api/v1/reportingGroups/identifiers

Get the IDs of the Content Provider (CP) reporting groups that you have access to. To run this operation, your user account needs the CPCode Rep Group role. To add this role, use the Identity and Access Management application.