Getting Started

Welcome to the ClicknClear documentation website.
If you’re here looking for the API documentation please use one of the following:

• Postman Collection (Recommended)
• Open API File
• In Browser

If you’re looking for anything else please see the side bar. If you can’t find what you’re looking for you can contact support@clicknclear.com for assistance.

Postman Collection (Recommended)

The file API Docs.postman_collection.json is an export from the postman collection which is the source of the API documentation. To load the documentation into postman do the following:

1. Create a new workspace (or use an existing one).

2. Click import, locate the API Docs.postman_collection.json file, and import it.

3. Setup a postman environment:

   • On the left hand side of postman click on the environments tab.
   • Click on the import button and locate the Main Environment.postman_environment.json file (supplied in this repo).
   • Update the keyID and keySecret variables with the values generated via your ClicknClear account. Further information on creating this can be found in the Postman collection documentation.

4. Run the login request (this will automatically populate the accessToken and refreshToken variables in your environment).

5. To view the documentation click on the three dots to the right of the “Main” collection and click “View Documentation”.

Open API/Swagger Docs

The Open API File is an automatic export of the Postman Collection into the Open API specification. The Auth and the Organisation paths require you to use the https://music.clicknclear.com/api server.