Broadsign Publish REST API
The Broadsign Publish REST API enables automation and simplifies the onboarding process by providing a clear and comprehensive overview of the Solution Project, including functional and non-functional requirements.
We use HTTP verbs, response codes, and authentication. All of our REST responses are in JSON.
You will need a token to use the Broadsign Publish REST API.
A token is a piece of data that has no meaning or use on its own, but combined with the correct tokenization system, becomes a vital player in securing your application. Token based authentication works by ensuring that each request to a server is accompanied by a signed token which the server verifies for authenticity and only then responds to the request.
To use the Broadsign Publish REST API:
- Access https://publish.broadsign.com/api/api-token-auth/ with the following data:
- Pass the token in the http header:
POST https://publish.broadsign.com/api/api-token-auth/
{
"username": "my username",
"password": "my password",
}
Replace the username
and password
with your own.
The Broadsign Publish REST API will return the following data:
"token":"THE_TOKEN"
[POST/GET/PUT] https://publish.broadsign.com/api/[api call]/
{
Authorization: Token [THE_TOKEN]
}
The verb used ([POST/GET/PUT]) depends on the API called.
The API call depends on the method that you are using.