Glossary: EndpointGlossary

An endpoint is a specific URL or URI where a particular resource or service can be accessed by the client. They define the points of interaction between the client and the server, enabling the client to perform various operations such as retrieving, creating, updating, or deleting resources.

Here are the key characteristics of an endpoint:

• URL structure: Endpoints are made up of the API’s base URL, followed by the path of that specifies the resource. For example, an endpoint that provides information about a customer whose id value is 123 could be https://api.example.com/customer/123. https://api.example.com/ is the base URL, and customer/123 is the path to the resource.
• Resource identifiers: These are identifiers at the end of the path that specify a specific resource or collection of resources that the client wants to interact with. For the endpoint https://api.example.com/customer/123, the resource identifier is 123.
• HTTP method: Endpoints are accessed using various HTTP methods, which determine the type of operation to be performed:
  • GET: Retrieve a resource or a list of resources from the API.
  • POST: Submit data to the API to create a new resource.
  • PUT: Update an existing resource.
  • DELETE: Remove an existing resource.
• Parameters: Endpoints can include query parameters or path parameters to filter, modify, or specify the resource further. These are key-value pairs added after the URL For example, the following request asks for a list of only the customers who are active: https://api.example.com/v2/customer?status=active.