Carousel Cloud’s REST API is available for any customer who has purchased our software! This KB is an informational resource for you to refer to, but it’s not a guide to using our API in general. We assume that if you're using our REST API, you understand that there is very limited support available when using our API.
Typically, someone would write a program that interacts with our REST API to accomplish a custom integration goal. Or maybe our software doesn’t quite do something, and it's too specific for us to build it as a feature for everyone. You could write your program that uses the REST API with some technical knowledge and direction.
Getting Started with API Keys
Creating an API Key
Navigate to Settings → Access → API Access Keys in your Carousel dashboard. You will need admin privileges to do so.
Click Create New API Key
Give your key a descriptive name (e.g., "Production Data Sync Script")
Assign appropriate permissions
Important: Save the generated key securely—you'll only see it once!
Using Your API Key
API Keys work with OAuth 2.0 Client Credentials flow. If you are creating a new authentication or updating legacy basic auth, use the format below:
Token Request:
POST /CarouselAPI/v1/auth/token Content-Type: application/x-www-form-urlencoded grant_type=client_credentials &client_id=YOUR_API_KEY &client_secret=YOUR_API_SECRET
Response:
{
"access_token": "eyJhbGc...",
"token_type": "Bearer",
"expires_in": 3600
}
Use the access_token in subsequent requests:
GET /CarouselAPI/v1/zones Authorization: Bearer eyJhbGc...
Want to learn more?
Read the Carousel REST API Overview on your Cloud Account via
<account>.carouselsignage.net/CarouselAPI
(e.g., support.demo.carouselsignage.net/CarouselAPI)Explore the Carousel API Documentation via
<account>.carouselsignage.net/CarouselAPI/swagger
(e.g., support.demo.carouselsignage.net/CarouselAPI/swagger)Feel free to review and read on our Demo account, as the information is the same
But you will need to use your account’s URL to authenticate, program, and test your API calls