Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 1.04 KB

README.md

File metadata and controls

22 lines (14 loc) · 1.04 KB

OpenAPI Explorer

The OpenAPI explorer is a different take on Swagger UI and is a way to view a OpenAPI/Swagger definition and execute API calls

Specifying a Swagger Definition in the url

The Open API explorer accepts a couple URL parameters for configuration

Param Location Description Example
openApiUrl query string The Url to the open api definition file https://api.mypurecloud.com/api/v2/docs/swagger
token_type url hash oauth token type to use with authenticated requests bearer
access_token url hash oauth access token

token_type and access_token are in the url hash to support oauth redirects.

Assuming that the OpenAPI explorer is hosted at https://developer.mypurecloud.com/openapi-explorer/, an example would be:

https://developer.mypurecloud.com/openapi-explorer/?openApiUrl=https://api.mypurecloud.com/api/v2/docs/swagger#token_type=bearer&access_token=Uf7UTEjT9SknXhdUz

Restrictions

  • Currently only supports OAuth2 bearer tokens