Overview
BrazenCloud is entirely API driven. Everything you do in the portal is translated to an API call for the backend. This means that you can browse the BrazenCloud portal using your browser's developer tools or run a tool like Fiddler to see exactly what API calls are being utilized.
SDKs
We currently have 2 SDKs available, but will be adding additional SDKs in the future:
If you would like to request an SDK for your language of choice, please contact us. We want you to be successful with our platform and we will provide the tools to make that happen. However, if you'd like to write your own client, the following documentation will be helpful.
API documentation
Swagger
You can find the comprehensive API documentation in Swagger format. At this time, descriptions are incomplete. So if you need any help, please contact us.
Authentication
If you are interested in implementing your own BrazenCloud API client in your language of choice, the Swagger docs covers everything except authentication.
To authenticate to the BrazenCloud API, you first need to POST to the Authentication_Login endpoint with the email and password for your BrazenCloud account. Here is the raw call:
POST https://portal.runway.host/api/v2/auth/login
Accept: application/json
Content-Type: application/json
{
"email": "[email protected]",
"password": "plaintextpassword"
}Assuming the submitted email and password is correct, here is what the response should look like:
{
"ttl": "00:20:00",
"session": "sessiontokenstring"
}On all subsequent API calls, use the sesion token in your Authorization header with 'Session ':
Authorization: "Session sessiontokenstring"Pagination
When making a request that returns multiple items, you can choose to return items in pages by specifying the skip and take parameters. The skip parameter specifies the number of objects to 'skip' and the take parameter specifies the number of items to 'take'.
For example, if you want to get the first 100 items, you would specify take=100 and skip=0. If you then wanted to get the second 100 items, you would specify take=100 and skip=100.
Last updated