Each API documentation page has areas and settings that make it easy for you to know how to use the ezyVet API. You can also make API calls and do API testing directly in each documentation page.

The example image and table that follow shows the areas and functions of an API documentation page:

Area	Function
1	Short information about the endpoint function.
2	The full URL of the API and endpoint for an environment that you can select. When you use the API testing interface that the page shows to select an environment, the URL automatically changes. Note: The environments that you can select are: ezyVet trial environment ezyVet production environment
3	Query parameters. Use a query parameter as a filter for the records that the API includes in responses.
4	A list of possible response codes that you can select. After you select a response code, the page shows: The body of the response code A list of data fields of the response code
5	The body of the response code that you selected.
6	A list of data fields for the selected response code.
7	The API testing interface. Use the testing interface to do tests of API endpoints directly from the page.
8	The Send API Request button. To send an API request that you used the API testing interface, select Send API Request . To select the environment to send to, use the box that is adjacent to Send API Request.
9	A visual equivalent in a specified programming language of an API request that you used the API testing interface to make. You can select the programming language or method that the visual equivalent shows as.
10	The API response for the API request that you used the API testing interface to make. The response always shows as JSON format.
11	The feedback box. Use the feedback box to give information about the documentation page to ezyVet customer support. For example, if you want information about an API endpoint that the page does not have, use the feedback box to tell ezyVet customer support.