Qodex.ai

Image and Video Manager API v2

Number of APIs: 21

Image and Video Manager transforms your website's images by creating derivative images of various sizes and formats, and dynamically selecting the best image when requested by your users. As a result, you can deliver a smooth, efficient, and visually engaging customer experience.

With this API, you can archive, manage, optimize, and deliver transformed images based on your defined policies, such as the width and format adjusted to the requesting device, operating system, and browser.

Authentication

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

Note: Only Akamai customers can create credentials. If you aren't an Akamai customer and wish to become one, you can sign up for our services.

  1. 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.

  1. 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.

  1. 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
  1. Fork the [Akamai Authentication] environment, populate the variables, and [set it for your workspace]

Dependencies

Make sure you have the following services configured before using this API:

  • To enable this API, go to the API list of your API client in Control Center, choose the API service named Image Manager, and set the access level to READ-WRITE.
  • Enable Image and Video Manager on a property via the Property Manager API, then use the Policy Set Name (API key) in the behavior for the Luna-Token header. In this API, you need to pass in an additional Luna-Token header with each request, which may look like this: default-022335.
  • If you want to generate a custom API token to apply a corresponding policy, use the imageManager behavior on a property via the Property Manager API.
  • Disable any products and features that are incompatible with Image and Video Manager, such as Adaptive Image Compression, Image Converter, Application Load Balancer, Phased Release, Audience Segmentation, and Kona Site Defender.

Integration methods

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

  1. Images - Get an image GET https://{{host}}/imaging/v2/network/:network/images/:imageId

  2. Image collections - List image collections GET https://{{host}}/imaging/v2/imagecollections

  3. Image collections - Create a new image collection PUT https://{{host}}/imaging/v2/imagecollections

  4. Image collections - Update an image collection POST https://{{host}}/imaging/v2/imagecollections/:imageCollectionId

  5. Image collections - Get an image collection GET https://{{host}}/imaging/v2/imagecollections/:imageCollectionId

  6. Image collections - Remove an image collection DELETE https://{{host}}/imaging/v2/imagecollections/:imageCollectionId

  7. Errors - List error details GET https://{{host}}/imaging/v2/network/:network/details/errors

  8. Image collection history - Get image collection history GET https://{{host}}/imaging/v2/imagecollections/history/:imageCollectionId

  9. Logs - List log details GET https://{{host}}/imaging/v2/network/:network/details/logs

  10. Policy sets - List policy sets GET https://{{host}}/imaging/v2/policysets