Start a conversation

The Basics 2: use swagger.json

By using https://petstore.swagger.io/ you can test the API directly from your web browser using the Swagger UI.

Visit the Swagger UI demo page, and enter the URL of the swagger file for the region you wish to test with, then click Explore

  • https://ap-southeast-2.docevent.io/documentation/public-api/swagger.json
  • https://us-east-1.docevent.io/documentation/public-api/swagger.json
  • https://eu-west-1.docevent.io/documentation/public-api/swagger.json

Once loaded all the API endpoints will appear in the UI.

Click the green Authorize button and enter your API key in the api_key field (you can ignore the other one) - Your API key can be found under the Account -> API section of the management page.

You can now click on the GET /ping request, then

  1. Click on the GET /ping API call
  2. Click "Try it out"
  3. Click "Execute"

A request will be made to the server from your browser, and the API call will return a result.

Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. Mariusz

  2. Posted
  3. Updated

Comments