endpoint

An endpoint is a specific access point of an APIGlossary · In briefAPIAn API is a defined way for software to exchange data or call functions in other software without needing to know how that software works internally.Read more. An application sends a request to that address to retrieve, add, modify or delete data. In web APIs, an endpoint is usually based on a URL, such as an address for all orders or one particular order.

What makes up an endpoint?

In an HTTP API, an endpoint often combines a web address and a method. The same URL can therefore support different actions. A GET request might retrieve data, while a POST request to the same address adds new data.

The API also defines which information a request must contain and which response the caller can expect. This includes required fields, response formats and possible error messages. The endpoint often uses authenticationGlossary · In briefauthenticationAuthentication is the process by which a system verifies the claimed identity of a user, device or application.Read more to establish who is making the request and checks whether that party has access.

Endpoint, route and API

The terms endpoint and route are sometimes used interchangeably. A route is usually the rule in server code that handles a particular path and method. The endpoint is the address another application can actually access. In practice, both often refer to the same combination of method and address.

An API usually contains several endpoints. An online shop might have separate endpoints for products, customers and orders. Together they define how other software communicates with the shop. One endpoint is therefore an individual part of the complete API.