All About The Bloom Growth API

Link Bloom Growth to other software

Bloom Growth has created an API to allow our clients to connect their favorite tools to our software.

What is an API? An application programming interface (API) is a set of subroutine definitions, protocols, and tools for building application software. This allows Bloom Growth data to be integrated with a wide variety of systems.

To use the Bloom Growth API, you must first generate a token via the instructions at https://app.bloomgrowth.com/swagger/index.html, or see below.

Once you have your token, view the complete API and use the options at https://app.bloomgrowth.com/swagger/index.html to get data.

How to Generate a Token

To interact with the API you'll need to request a token. This is done with a post request to the server. Tokens are only valid for 2 weeks. After this, a new one must be generated.

The post request requires three parameters.

grant_type which is always "password"
userName which is your login email
password which is your login password

The post request is delivered to https://app.bloomgrowth.com/token. The following is a curl.

curl -i -X POST

"grant_type= password"

"userName= <strong>YOUR_USERNAME_HERE</strong>"

"password= <strong>YOUR_PASSWORD_HERE</strong>"

'https://app.bloomgrowth.com/token'

This will return json that looks similar to the following:

{ "access_token":"qriivcbIB143adasdVuweqweasdVidi-wqfayefGFa63IiaJasdf325salo10asdf0vaxcve0awRUPph-KDSgqweascvoxzxf 
"expires_in":1209599, "userName":"user@organization.com", ".issued":"Mon, 28 Dec 2015 07:05:37 GMT", 
".expires":"Mon, 11 Jan 2016 07:05:37 GMT" }

The access_token will be used in all future requests. Notice the token_type. It indicates that this access_token is a Bearer token.

Formatting a Request:

Once you have your Bearer token. You must add it to the header of all future requests.

Example: GET a listing of Metrics

curl -i -X GET -H "Authorization:Bearer YOUR_BEARER_TOKEN_HERE" 'https://app.bloomgrowth.com/api/v1/scorecard/items/'