In the API Preview, you have access to a comprehensive overview of all endpoints, including built-in ones like "Auth" and "Health" endpoints.
The API preview conveniently consolidates all endpoint information in a single location, presenting details about available parameters, HTTP request methods, response statuses, and response bodies. Additionally, you can easily identify whether an endpoint is secure or not.
Furthermore, the API Preview provides example requests and responses for each endpoint, enabling you to understand how to interact with the API effectively. These examples offer a practical demonstration of the data format expected in the request and the data you can anticipate in the response.
What are Endpoints?
An endpoint refers to a specific URL (Uniform Resource Locator) that a client can access to interact with the API and perform various operations. Endpoints act as gateways that allow clients (such as web or mobile applications) to communicate with the server hosting the API and perform actions like ...
Built In Endpoints
By default, each API is equipped with pre-built endpoints, providing essential functionalities like health checks and API authentication and security right from the start. All the information regarding these built-in endpoints can be easily accessed through the API preview, offering a comprehensive ...