Explore API documentation lets developers experiment with an API’s functionality directly within the documentation. It’s a great way to validate an API’s accuracy and usability, and it provides valuable insights into the user experience (DX).

When you click “Try It” on an API action in Explore, our system displays information about the request and the response. You can also review the code that was generated to make the API call. If you’ve entered any parameters in the API call, those values will display in the code box along with their descriptions on the left side. The right side of the code box contains the SDK call syntax for the programming language that you’ve selected in the language selector drop-down.

Explore API Documentation: Easy Integration & Setup

If the API method can change data (that is, it’s a POST, PATCH, UPDATE, or DELETE), then the response will also include a checkbox for confirming that you want to change the data. You can view the request and response in either JSON or XML format.

For APIs with a standardized schema, you can select the OpenAPI tab on an API tile to see the complete OpenAPI specification for that API. The OpenAPI specification includes information about the operations and paths, and the schema definitions that comprise the API. This information can help you understand the structure of the API and ensure that it is compatible with your application’s existing database. You can also find links to related resources and other useful information about the API.