Glossary
This glossary provides definitions for key terms and concepts used throughout the API documentation.
| Term | Definition |
|---|---|
| API | Application Programming Interface. A set of rules and endpoints that allows applications to communicate with the system. |
| Endpoint | A specific URL through which a client can access an API resource or perform an operation. |
| Authentication | The process of verifying the identity of a client or user making an API request. |
| Authorization | The process of determining whether an authenticated client or user has permission to perform a specific operation. |
| API Key | A unique credential used to identify and authenticate an application when accessing the API. |
| Access Token | A credential included with API requests to authorize access to protected resources. |
| Payload | The data sent in the body of an API request or returned in the body of an API response. |
| Parameter | A value supplied to an API request to control or provide information for an operation. Parameters may be included in the path, query string, or request body. |
| Header | Metadata sent with an HTTP request or response, such as authentication information or content type. |
| Resource | An entity or object exposed through the API, such as a customer, order, or transaction. |
| Schema | A formal definition of the structure, data types, and validation rules for an API request or response. |
| Idempotency | A property that allows the same request to be safely repeated without producing additional unintended effects. |
| Rate Limit | The maximum number of API requests a client is allowed to make within a specified period. |
| HTTP Status Code | A three-digit code returned by the server indicating the result of an API request, such as success, client error, or server error. |
| Deprecated | Indicates that an API endpoint, parameter, field, or feature is no longer recommended and may be removed in a future version. |
| Breaking Change | A change that may cause existing API clients or integrations to stop working correctly. |
| Sandbox | A non-production environment used for development, testing, and integration. |
| Production | The live environment used by real clients and applications. |
| JSON | JavaScript Object Notation. A lightweight data format commonly used for exchanging data through the API. |
| UUID | Universally Unique Identifier. A standardized identifier commonly used to uniquely identify API resources. |