This OpenAPI (formerly Swagger) Specification is an API description format written for the OpenChannel REST API. It allows you to interact with the OpenChannel API with minimal effort to understand the available endpoints and what operations can be performed.

You are able to browse the different API methods and then by clicking “Try It Out” you will receive the response. We recommend starting with calls like:

  • GET /apps – This call will display all approved apps in your marketplace
  • GET /apps/versions – This call will return all apps that have been submitted by developers

There are additional examples of each method in the OpenChannel API Documentation.

You can access the OpenChannel Swagger Specification at this URL: https://app.swaggerhub.com/apis/OpenChannel/Market-API

Swagger

 

This is also accessible within your OpenChannel Administrator Dashboard as “Try the API” under the Help menu.

 

Help Spec