Glossary

Item
Definition

API

Application Programming Interface: A set of rules and protocols that allows different software applications to communicate and exchange data with each other. It defines the methods and data formats that applications can use to request and share information, without needing to know how the other system is implemented.

API Key

A unique string of characters used to authenticate an application or user making a request to an API. It helps to identify the caller, track API usage, and control access to the API's resources.

Endpoint

A specific URL that represents a particular function or resource within an API. When your application makes a request, it sends it to an endpoint to access a specific piece of data or perform a certain action.

JSON

JavaScript Object Notation; a lightweight data format for sending information

Payload

The actual data contained within an API request or response. In a request, the payload is the information you are sending to the server. In a response, it is the data the server sends back to you.

Webhook

An automated mechanism that allows one application to send real-time data to another application as soon as an event occurs. Instead of your application repeatedly asking for new information (polling), a webhook pushes the information to your application when it becomes available

HTTP Status Code

A standard three-digit code included in an HTTP response that indicates the outcome of a request. These codes quickly communicate whether a request was successful, if there was an error, or if further action is needed (e.g., 200 OK, 404 Not Found, 500 Internal Server Error).

Rate Limiting

A control mechanism that restricts the number of API requests a user or application can make within a specified time period. This is used to prevent abuse, ensure fair usage, and maintain the stability and availability of the API for all users.

Last updated