Key concepts and terms

The following definitions can help you follow the instructions in this document.

API Gateway terms

TermDefinition
API consumerA user, machine, or application that interacts with an API.
API definition fileA file in an OpenAPI (Swagger) or RAML format that includes information about your API configuration.
API endpointAn application that hosts one or more API resources with a common base path. The representation of an API endpoint is a unique URL that includes a hostname and a base path.
API gatewayA single-point software layer between one to many API services and their consumer applications.
API keyA unique identifier that enables edge servers to authenticate, track, and manage API consumers.
API resourceA service within an API endpoint represented by a URI. You can interact with an API resource via its allowed methods.
BehaviorIn Property Manager, an element in a rule that specifies a feature to apply to requests. A rule can have many behaviors or only one.
Digital propertyAn identifier that indicates which property file and application to use when processing incoming HTTP requests. Often, the digital property is the full, end-user-facing hostname or fully qualified domain name of your application. For instance, www.example.com might be both your domain name and your digital property name. The term ‚Äúproperty‚ÄĚ is more general and can include several digital properties (such as www1.example.com, www2.example.com, www3.example.com, etc.). So, if you have multiple hostnames associated with a single domain, those digital properties would be managed under one property in Property Manager.
Edge hostnameA customer-specific subdomain on a domain that maps incoming requests to edge servers. Typically, customers specify edge hostnames in Canonical Name (CNAME) records.
Edge serverAn ‚ÄčAkamai‚Äč -owned server that receives end-user requests and provides an integrated suite of services for content and application delivery, content targeting, edge processing, and business intelligence.
Origin serverThe server where you keep your content. ‚ÄčAkamai‚Äč retrieves content from the origin server and serves it from edge servers.
Origin server hostnameThe hostname mapping to the customer’s origin server where edge servers retrieve your content.
Property ManagerThe application that you use to provision, configure, test, and activate your digital properties.
RuleIn Property Manager, an instruction that controls how ‚ÄčAkamai‚Äč applies features to requests. Rules consist of two parts: match criteria and behaviors. If a request fulfills the requirements given in a rule‚Äôs match criteria, ‚ÄčAkamai‚Äč applies the features configured in that rule‚Äôs behaviors. A configuration typically has multiple rules.