API terminology

Build a strong API vocabulary and learn more about how APIs are designed, developed, deployed and managed.

A

API (Application Programming Interface)

A set of protocols, routines, and tools for building software applications that specify how software components should interact.

API Call

A request made by a client application to an API endpoint to retrieve data or perform an operation.

API Client

A software application or library that makes requests to an API.

API Endpoint

A specific URL where an API can be accessed by a client application.

API Gateway

A server that acts as an API front-end, receives API requests, enforces throttling and security policies, and routes requests to backend services.

API Key

A unique identifier used to authenticate a user, developer, or calling program to an API.

API Key Authentication

A simple authentication method where a unique key is passed with each request.

API Version

A specific version of an API that may have different features, endpoints, or behaviors.

Application ID

A unique identifier assigned to an application for API access and tracking purposes.

Accept

Specifies the media types that the client can handle in the response.

application/json

The MIME type for JSON data, commonly used in API requests and responses.

application/xml

The MIME type for XML data.

Authentication

The process of verifying the identity of a user or system making an API request.

Authorization

The process of determining whether an authenticated user has permission to access specific resources or perform certain operations.

B

Base URL

The root URL for an API that serves as the starting point for all API endpoints.

Bearer Token

An access token that grants access to resources, typically passed in the Authorization header.

Bearer Token Authentication

An authentication method where a token is passed in the Authorization header.

Booking Status

The status of a transaction indicating whether it has been finalized in the account (e.g., booked, pending).

C

cURL

A command-line tool for making HTTP requests, commonly used for testing APIs.

Certificate Authentication

An authentication method using digital certificates for secure communication.

Client Certificate

A digital certificate used by a client to authenticate itself to a server.

Content-Type

An HTTP header that indicates the media type of the request or response body.

E

Endpoint

A specific URL where an API can be accessed and a specific function can be performed.

Error Code

A numeric or alphanumeric code that indicates a specific type of error in an API response.

Error Message

A human-readable description of an error that occurred during an API request.

F

Frequency Per Day

A rate limiting parameter that specifies how many times an API can be called per day.

H

HTTP Headers

Key-value pairs sent with HTTP requests and responses that provide additional information about the request or response.

HTTP Methods

The different types of requests that can be made to an HTTP server (GET, POST, PUT, DELETE, PATCH).

HTTP Status Codes

Three-digit codes returned by servers to indicate the result of an HTTP request (e.g., 200 OK, 404 Not Found).

I

Integration

The process of connecting different software systems or APIs to work together.

J

JSON (JavaScript Object Notation)

A lightweight data interchange format that is easy for humans to read and write.

L

Load Balancing

The distribution of incoming API requests across multiple servers to ensure optimal resource utilization.

M

Mock Transaction

A simulated transaction used for testing purposes without affecting real data.

Mobile Flow

An API interaction pattern designed specifically for mobile applications.

O

OAuth

An open standard for access delegation, commonly used for token-based authentication.

OAuth 2.0

A more complex authentication framework that allows third-party applications to obtain limited access to user accounts.

Ocp-Apim-Subscription-Key

A subscription key header used for authentication in Azure API Management services.

P

Path Parameters

Variables in the URL path that are used to identify specific resources.

Payload

The data sent in the body of an HTTP request or response.

Q

Query Parameters

Key-value pairs added to the end of a URL to provide additional information to the server.

R

Rate Limiting

The practice of limiting the number of API requests a client can make within a specific time period.

Request Body

The data sent in the body of an HTTP request, typically used with POST and PUT methods.

Request ID

A unique identifier for an API request, used for tracking and debugging purposes.

Response Body

The data returned by the server in response to an API request.

REST (Representational State Transfer)

An architectural style for designing networked applications using standard HTTP methods.

RESTful API

An API that follows REST architectural principles.

S

Sandbox

A testing environment that allows developers to test API functionality without affecting production data.

SDK (Software Development Kit)

A collection of software development tools and libraries for building applications that interact with an API.

Status Code

A three-digit number returned by a server to indicate the result of an HTTP request.

Subscription Key

A key that identifies a subscription to an API service, used for authentication and billing.

T

Testing Environment

A separate environment used for testing API functionality before deploying to production.

text/plain

The MIME type for plain text data.

Timeout

The maximum amount of time to wait for an API response before considering the request failed.

Token

A piece of data that represents authentication credentials or authorization permissions.

U

UAT (User Acceptance Testing)

A testing phase where end users test the API to ensure it meets their requirements.

URL (Uniform Resource Locator)

The address used to access a resource on the internet.

User-Agent

Identifies the client application making the request.

UUID (Universally Unique Identifier)

A 128-bit number used to uniquely identify information in computer systems.

V

Validation

The process of checking whether API input data meets the required format and constraints.

Version Control

The management of changes to API versions and their corresponding documentation.

W

Web Flow

An API interaction pattern designed for web-based applications.

X

X-Request-ID

An HTTP header that contains a unique identifier for tracking requests across systems.