Trying REST APIs

Before you begin

  • If the API that you are trying is protected with an API key, then create an application to establish your identification. For information about creating applications, see Creating applications.
  • Expand the menu options, click Administration, and click General. Turn the Enable SSL validation for tryout setting off. By default, this setting is enabled. You must turn off this setting to test APIs.

Procedure

  1. Go to the Try API page by using one of the following ways:
    1. Click the Tryout icon in the corresponding API tile.
    2. 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 a method according to your requirements.
  3. Optional: Turn the Show code slider on to view the sample code for the selected resource.
  4. 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.

  5. Provide the following 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.

  6. Provide the authorization details from the Authorization tab.
    For information about the authorization types and inputs, see Authorization fields.
  7. Select a 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.
  8. Click Send.
    The response body and headers appear in their respective sections.