Trying a REST API
This section explains how you can test a REST API.
Pre-requisites
If the API that you are trying is protected with API key, JWT, or OAuth, then create an application to establish your identification. For information about creating applications, see
Creating an application.
To try a REST API1. Navigate to the Try API page using one of the following ways:
Click the Tryout icon
in the corresponding API tile.
Click
Try API from the API details page of the corresponding API.
The Try API page appears. The resources that you can test appear in the left pane.
2. Select a resource and the required method.
3. Provide the following values in the Parameters tab:
Key. Key value of the parameter.
Value. Value of the corresponding key parameter.
You can click Add new and add multiple entries.
4. Provide the following required values in the Headers tab:
Key. Value of the header key.
Value. Value of the corresponding key parameter.
You can click Add new and add multiple entries.
5. Provide the authorization details from the Authorization tab.
6. Select the required request form from the Request body tab and provide your request:
form-data. To send your request in the form of the key-value pairs. You can select
Text and provide your form key and value or select
File and attach the request file.
x-www-form-encoded. To send your request in the form of the encoded key-value pairs.
raw. To provide any request. You can provide the request in JSON or XML format.
None. To send the test request without a request body.
7. Click Send.
The response body and headers appear in their respective sections.
Alternative steps
After you perform Step 2, you can turn the Show code slider on to view the sample code for the selected resource.
