How to test API from this documentation

You can send test requests on each API endpoint. You can set request parameters at the bottom of each endpoints docs.

Send a test request
Send a test request

Authentification

Before sending a test request, you need be authentified.

  • Retreive your “oauth_access_token” by clicking on “Get access Token” and fill the form (set Client ID and Client Secret)
Retreive Access Token
Retreive Access Token

Play with the API

  • Select the endpoint to test
  • Set request parameters
    • Multiple tabss allow you to set “Path params”, “Query parameters” and/or “Headers”
  • Click the “Send” button
Set query parameters
Set query parameters

Save the portal id for next usage

Many requests need the portal’s ID to know which portal to make the request on. To avoid typing the portal ID on each test you can set it in $$.env settings and use the variable {$$.env.portalId} on path params.