TrainingSupportCommunity

Get started

Review the content here to make sure you're ready to start working with the Cloud Wrapper API.

Get Cloud Wrapper on your contract

Make sure Cloud Wrapper is on your contract:

  1. Access ​Akamai Control Center​.

  2. Select ☰ > ACCOUNT ADMIN > Contracts.

  3. Click your Contract ID in the table.

  4. Type cloud in the Filter field:

    • If you see Cloud Wrapper. You're ready to go.

    • If you don't see Cloud Wrapper. Reach out to your ​Akamai​ account team to get it added.

Set up authentication credentials

You use the Identity and Access Management tool in ​Akamai​ ​Control Center​ to set up an API client. An API client consists of several values your API client uses to authenticate calls to ​Akamai​ APIs. While you're creating your API client, you'll need to do the following:

  1. Verify you have the API service. In Identity and Access Management, you'll come to the API client for you interface. Click Show additional details and look for the Cloud Wrapper entry in the APIs table and make sure its access level is set to READ-WRITE. This gives you access to all operations in this API. If you don't see it, or it's set to READ-ONLY access, talk to your company's ​Akamai​ administrator to get your user updated, or reach out to your ​Akamai​ account team.

  2. Gather values. In the Credentials section, make note of the client_secret, host, access_token, and client_token values.

🚧

The client_secret is only revealed once

This value is only revealed after you first create an API client. You can't come back to this interface to get it. So, make sure you make note of it for use. You can use the Download or Copy credential buttons in the interface to save all of your values.

Get your identifiers

Your contractId

This applies to the contract that includes the Cloud Wrapper product. Several operations in this API require this value. You can find your contractId using the Contract API:

  1. List contracts. If you only have one, you’re done. Store this as your contractId. If you have more than one, note these values and continue.
  2. List products per contract. Set the {contractId} variable to one you’ve noted.
  3. Look for a marketingProductId of Cloud Wrapper in the response. If you find it, this contract has Cloud Wrapper enabled, and you can use this contractId.

Your groupId

You create the objects that make up your delivery workflow with a specific user. This includes your delivery properties and Cloud Wrapper configuration. Your user belongs to a specific group within your contract. You need the unique identifier that ​Akamai​ assigns to your group, for various operations in the API.

  1. Get your contractId for the contract that has

Know the workflow

There are several things you can do with the Cloud Wrapper API, key among them is creating a Cloud Wrapper configuration. Here are the basic steps to get this done:

1. Work with your ​Akamai​ account team

You'll start by determining your capacity needs and adding that capacity to your contract and the Cloud Wrapper portal.

2. Set up a delivery configuration ("property")

Your property determines how your content is delivered via the ​Akamai​ edge network. You can use several ​Akamai​ delivery products, based on your need. Media delivery products include Adaptive Media Delivery, Download Delivery, or Object Delivery, while website delivery products include Ion or Dynamic Site Accelerator. You'll need the applicable product on your contract and you'll use the Property Manager API (PAPI) to set up your property.

Store the propertyName you set for it. You'll need it when creating your Cloud Wrapper configuration.

📘

Cloud Wrapper for web-based products (Ion and Dynamic Site Accelerator) is in beta. Talk to your account team to see if you're eligible to participate in the beta program.

3. Create and activate your Cloud Wrapper configuration

This is the amount of cache space you're allocating in a specific geographic region.

4. Add the Cloud Wrapper behavior to your property

Use PAPI to add this behavior to enable it in your property. Select a location you've established in your Cloud Wrapper configuration to use its cache space.

  • Get a configuration. Run this operation using the id you stored to verify that its activation status is ACTIVE.

  • Add the behavior. Get the cloudWrapper behavior added to your property rule tree.

5. Configure your origin server

Use PAPI once again to configure the origin behavior in your property to set up the origin server where your deliverable content lives. Cloud Wrapper leverages this information to get your content and store it in its cache.