Glossary

API: An abbreviation for "application programming interface," serves as an intermediary between users and their data bridging different software applications together.

Developer Portal: The website you are currently on, the platform where you can access APIs, explore documentation, and manage your developer account.

Endpoint: A specific URL within an API that allows clients to interact with its resources.

Flat: Data returned in this format presents data in a single, non-nested structure as a list of records.

Hierarchy: Data returned in this format presents data in a nested structure, where records can contain other records or collections of records, representing relationships and parent-child dependencies within the data.

Payload: The data transmitted in a request or response formatted in either JSON or XML.

Request: A message sent from a client to an API endpoint, typically to retrieve or modify data.

Response: The data returned by an API endpoint after processing a client's request.

Status Code: Numerical code returned by a server in response to a client's request, indicating the outcome of the request, such as success, failure, or error. When a successful request is passed, this code will be "200".

Subscription Key: Unique identifier assigned to developers upon subscribing to an API, used for authentication and authorization to access and consume the API's resources securely.