This page will help you get started with Braid Technologies API.
About our APIs:
Braid APIs are REST-based and return responses in JSON format.
HTTP request methods such as GET, PUT, and POST are utilized as well as standard status codes for successful and unsuccessful requests.
All requests are sent via HTTP to unique URL endpoints.
Authentication:
The Braid API uses basic authentication to authenticate requests. It uses a Base64 format to encode username and API key both of which are stored in the HTTP header.
During the developer onboarding process, a unique username and password is created for the user. The developer needs to log into the Braid dashboard to view and manage the unique API keys that are auto-generated.
An API key is a unique identifier issued by the API provider to authorized users or applications. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Status and Error Codes:
The colored symbols below in green represent the good (OK) status codes and in red for the bad (Error) status codes.
| HTTP Status Code | Reason | Detailed Explanations |
|---|---|---|
| ✅ 200 | OK | This is the standard response for successful HTTPS requests. The actual response will depend on the request method used. This will apply to GET, PATCH, DELETE, and PUT requests. |
| ✅ 201 | OK | This is the standard response for successful HTTPS requests. The actual response will depend on the request method used. In a POST request, the response will contain an entity describing or containing the result of the action. This code will only apply to POST requests. |
| ✅ 204 | OK | This is if there is no response for a successful request. |
| 🛑 401 | Unauthorized | The request requires user authentication. Invalid credentials were provided or the user doesn’t have permission to perform the requested operation. |
| 🛑 403 | Forbidden | The server understood the request, but is refusing to fulfill it. Authorization doesn’t help here. |
| 🛑 404 | Not Found | The server has not found anything matching the requested URI (Endpoint). This could be a wrong URL or the resource doesn’t exist. |