API concepts

This section describes the conceptual objects you deal with when interacting with this API, and provides pointers to where you can learn more.

  • Endpoint. The use of the term endpoint in this documentation refers to an API service. This API refers to responsive URL patterns as resources. For most Akamai APIs, responsive URL patterns are commonly referred to as endpoints, not as resources. Within this API, an endpoint refers to a logical collection of resources.

  • Version. The API version that you set up to make your endpoint, resource, and delivery configurations effective. You can activate an API version in the Akamai staging or production environment.

  • Resource. A URL pattern that responds to HTTP method calls for each API operation.

  • Delivery settings These settings let you configure API privacy, JWT validation, CORS, caching, GraphQL caching, origin request redirect, GZIP compression, and error response customization. Enabling these features can help you manage your APIs more efficiently, improve interoperability, provide useful guidelines to API consumers in case of errors, define the level of access to your APIs for external client apps, and enhance the overall performance of your API traffic.

  • Category. You can assign any number of overlapping categories to each endpoint.

  • Contract. You provision API endpoint services under an Akamai contract, and also assign a Control Center group.