Getting Started

Welcome to the Rockbot Developer Portal! To get started, first reach out to support@rockbot.com with the subject line Rockbot API Access and include a link to your Dashboard in the email. The email must be from the same account tied to your Rockbot user.

Currently, music is the only available scope via the Rockbot API, but more scopes will be available soon.

Authentication

The Rockbot API authenticates via the OAuth 2.0 Client Credentials grant.

Client Secret

Once your access has been approved, you will receive an email with your client id and a one-time link to reterieve your CLIENT_SECRET. Your credentials will be limited to the scopes requested.

https://api.rockbot.com/v5/api-clients/CLIENT_ID/secret?one_time_code=XXXXXXXX

WARNING

This secret will only be visible one time so store this somewhere confidentially after requesting.
Do not share this code publically.

Access Token

Use your CLIENT_ID and CLIENT_SECRET to obtain an temporary ACCESS_TOKEN which will be used to authenticate API requests via Bearer Authentication

Request

curl -X POST https://api.rockbot.com/v5/api-clients/token \
-H  "Content-Type: application/json" \
-d '{ "client_id": "CLIENT_ID", "client_secret": "CLIENT_SECRET" }'

NOTE

Your access token will be valid for 24 hours, and will need to be refreshed within that interval

Continue to the Rockbot API Reference.

Limits

By default, your API client will by limited to 1 request per second. HTTP Cache-Control headers should be respected to reduce uneccessary requests to the API. Please contact support@rockbot.com if your application requires a higher request limit.