Understanding the details of an API call

The details of all the API calls are included on the API Docs (Swagger) web page. All of the API calls are documented and displayed using a common format. By understanding a single API call, you can interpret the details of all the API calls.

Steps

  1. On the main API Docs page, click sessions.
  2. Click POST to display the details of the API call used to request an authentication token.


    example API call showing details

  3. Examine the entire page to understand the API calls and what you must enter.
    You should note the HTTP verb and URL, required input parameters, the HTTP status codes used, and any implementation notes.