Bridgit Bench’s open API provides users the framework to develop custom integrations between their tech stack and Bridgit Bench. Users are able to build customized connections and develop new applications using the Bridgit Bench API.
Bridgit Bench API endpoints provide the ability to easily make calls to retrieve information and/or execute actions on the projects and people in your Bridgit Bench account. If you’re planning to build your own applications, the Bridgit Bench API allows you to leverage your resources within the app using conventional HTTPS requests in a RESTful architecture.
Table of Contents
Authorization
To start using the Bridgit Bench API to leverage your current tech stack, contact Bridgit or an account Admin to be sent an invite to join Bridgit Bench so you can set up a service account. Administrator permissions are required to create a service account.
Once the invite has been received and you’ve successfully logged in, follow these steps to create a service account that will allow authentication through the API.
A service account with admin permissions will need to be set up to modify or create new data through the API.
You can now use the service account credentials to be authenticated through the API.
Authentication
API requests are authenticated using an OAuth bearer token. In order to get a token, authenticate your user by sending a POST request to "/auth/signin" with your service accounts “unique identifier” and “password” parameters form-encoded in the body of the request. The response will be a JSON object including an “access_token” property.
Sessions
Every user can have up to 3 active sessions and each session is generated each time the request is made to "/auth/signin". Each additional session will remove the existing oldest active session. In order to end your session, send a request to "/auth/signout".
For security purposes, each session will expire after 24 hours if there’s no activity with that session token; otherwise, the session will continuously refresh itself on each request. After the session has expired, the user will be required to sign in again or exchange their refresh token for a new session. Refresh tokens are valid for 7 days from the time of issue and may be used only once.
API Documentation
View the API documentation by clicking on the following links: