Skip to content

Glossary

APIs & Integrations

APIs and integrations allow separate software systems to exchange information, trigger actions, and work together without relying on manual data entry.

Terms

API An API is a defined interface that allows one software system to interact programmatically with another. API Endpoint An API endpoint is a specific address or operation exposed by an API for interacting with a particular resource or function. API Key An API key is a credential used by software to identify or authenticate an application making requests to an API. API Request & Response An API request asks an API to retrieve information or perform an action, while the response communicates the resulting data, status, or error. API Versioning API versioning maintains identifiable versions of an API so its behaviour can evolve without unexpectedly breaking integrations built against earlier contracts. APIs & Integrations APIs and integrations are the interfaces, rules, and connections that allow separate software systems to exchange information and coordinate actions. Authentication Authentication is the process of verifying the identity of a user, application, or system attempting to access a service. Authorization Authorization determines which information and actions an authenticated user or application is permitted to access. Cross-Origin Resource Sharing (CORS) Cross-Origin Resource Sharing is a browser security mechanism that controls whether scripts from one web origin can access resources provided by another. Data Synchronization Data synchronization is the process of keeping related information consistent between two or more software systems. HTTP Method An HTTP method communicates the intended action of a request, such as retrieving, creating, updating, or deleting information. Idempotency Idempotency allows an operation to be safely repeated without creating additional unintended effects after the first successful application. JSON JSON is a text-based data-interchange format commonly used to represent and exchange structured information between software systems. Middleware Middleware is software that sits between systems to coordinate communication, transform data, route actions, or apply integration logic. OAuth OAuth is an authorization framework that lets an application receive limited access to another service without receiving the user's primary account credentials. Pagination Pagination divides a large API result set into smaller groups that can be requested and processed separately. Payload A payload is the meaningful data carried inside a request, response, webhook, or other message exchanged between systems. Polling Polling is an integration pattern where one system repeatedly requests another system to check whether information has changed. Rate Limit A rate limit restricts how many API requests a client can make within a particular period or usage allowance. REST API A REST API is a web API organized around resources and standard HTTP concepts such as URLs, request methods, headers, and status codes. Webhook A webhook is an event-driven message automatically sent from one system to another when a defined event occurs.