RESTFul API для BSC Designer Online

Для автоматизации ввода данных и для интеграции с другими инструментами BSC Designer Online предоставляет разработчикам RESTFul API.

Общая информация

Первые шаги

Инструкции ниже помогут начать использовать API.

Токен авторизации

Перед выполнением API запросов необходимо получить авторизационный токен. Отправьте на login endpoint такие данные:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

{

"email" : "заменить_на_емейл_счёта",

"password" : "заменить на пароль"

}

ответ в JSON формате будет содержать параметры errorMessage и token:

{

"email": "string",

"errorMessage": "string",

"success": true,

"token": "string"

}

Используйте полученный параметр token в заголовках всех API запросов:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

Token: заменить_полученным_tocken

Получение IDs для scorecard и KPI

API запросы связанные с индикаторами требуют в качестве параметра ID scorecard-а и GUID индикатора.

Получение Scorecard ID

  1. Перейдите в раздел "Мои проекты"
  2. Откройте нужный scorecard
  3. Адрес scorecard будет в таком формате https://www.webbsc.com/s/123456
  4. Число на конце ссылки является ID scorecard-а

Получение KPI GUID

KPI GUID может быть получен используя API запрос или вручную. Чтобы получить GUID вручную:

  1. Откройте scorecard
  2. Выберите "Инструменты" > "Экспортировать величины индикаторов"
  3. Перейдите к шагу "Предпросмотр результатов экспорта"
  4. Колонка "GUID" в таблице предпросмотра будет содержать GUID KPI

Запись и чтение величин через API

Используйте KPI Value Controller для записи и чтения данных в/из KPI.

Пример использования API: пример на php.