RESTFul API for BSC Designer Online

For easier automation of data entry and integration with 3rd party tools BSC Designer Online provides RESTFul API.

General information

• Documentation. The documentation for the API calls is available here.
• Limitations. API can be used only by the owner of the account. An account has a limit of 100 API calls per hour per power user.

Getting started

Find below some instructions that will help to get started.

Authorization token

Before submitting API calls an authorization token need to be obtained. Send the following data to the login endpoint:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

{

"email" : "replace_with_access_email_here",

"password" : "replace_with_access_password_here"

}

the response in JSON format will contain errorMessage and token parameters:

{

"email": "string",

"errorMessage": "string",

"success": true,

"token": "string"

}

Use obtained token parameter in the headers of all other calls to the API:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

Token: replace_with_obtained_token

Getting IDs for scorecard and KPI

API calls related to the KPI require the ID of the scorecard and the GUID of the KPI.

Getting Scorecard ID

Scorecard ID can be found using API call or manually. To find Scorecard ID manually:

1. Go to the "My scorecards" section
2. Open the target scorecard
3. The URL of the scorecard will be something like this: https://www.webbsc.com/s/123456
4. The number at the end is the ID of the scorecard

Getting KPI GUID

KPI GUID can be found using API call or manually. To find GUID manually:

1. Open scorecard
2. Select "Tools" > "Export indicator values"
3. Follow the steps to get to the "Preview export results" page
4. "GUID" column in the preview table will contain GUID of the KPI

Writing and Reading value using API

Use KPI Value Controller to write and read data for the KPIs.

• Remember to use token in the header of the requests
• Dates should be in the yyyy-MM-dd format (for example "2017-06-30")
• Data is sent and received in JSON format
• To optimize call numbers use batch calls
• To read grouped, calculated, or inherited values use Grouped Values Controller

Check out the php example of using API.