Swagger Documentation

Each API is fully documented using Swagger, providing a comprehensive overview of available endpoints. Detailed descriptions are included for each API, along with the parameters, request formats, and response structures. Additionally, the documentation allows for real-time execution of API requests directly within the interface. The URL for swagger is
https://<api url>/docs/swagger/index.html.

Hints and Tricks

  • When using Swagger for testing, you must first login to execute the API’s. First, you must know the API Key. Here is how to use swagger to login:

    • Open the swagger document in a browser https://<api url>/docs/swagger/index.html
    • Find the Access section on the bottom of the page.
    • Click /v1/token/{accessKey}
    • Click Try Out
    • Enter your Access Key and click Try Execute
    • Copy the token in the API Response.
    • At the top of the page, on the right, click “Authorize” and paste the token.
    • You’re not ready to use the API’s that your token has access.

  • There are many enums in the ShowingHub. It’s not easy to find for someone new to viewing Swagger documents. Click the “Schema” link. The enum values are in the “Member’s” section.

image.png