API RESTFul para a BSC Designer Online

Para uma automação mais simples da introdução e integração de dados através de ferramentas de terceiros, a BSC Designer Online oferece a API RESTFul.

Informação geral

• Documentação. A documentação para as chamadas API está disponível aqui.
• Webhooks. Os alertas no BSC Designer podem ser configurados para enviar webhooks.
• Limitações. A API pode ser utilizada apenas pelo proprietário da conta. Uma conta tem um limite de 100 chamadas API por hora por cada usuário power.

Começando

Encontre abaixo algumas instruções que ajudarão você a começar.

Token de autorização

Antes de submeter as chamadas API é necessário obter um token de autorização. Envie os seguintes dados para o endpoint de autenticação:

POST /rest/login HTTP/1.1

Host: https://pt.webbsc.com

Content-Type: application/json

{

"email" : "replace_with_access_email_here",

"password" : "replace_with_access_password_here"

}

a resposta em formato JSON irá conter os parâmetros errorMessage e token:

{

"email": "string",

"errorMessage": "string",

"success": true,

"token": "string"

}

Utilize o parâmetro token obtido nos cabeçalhos de todas as outras chamadas para a API:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

Token: replace_with_obtained_token

Obtendo os ID para o scorecard e KPI

As chamadas API relacionadas com o KPI exigem o ID do scorecard e o GUID do KPI.

Obtendo o ID do Scorecard

O ID do Scorecard pode ser encontrado utlizando a chamada API ou manualmente. Para encontrar manualmente o ID do Scorecard:

1. Vá na seção "Meus scorecards"
2. Abra o scorecard alvo
3. O URL do scorecard será algo como isso: https://pt.webbsc.com/s/123456
4. O número no final é o ID do scorecard

Obtendo o GUID de um KPI

O GUID de um KPI pode ser encontrado utilizando a chamada API ou manualmente. Para encontrar manualmente o GUID:

1. Abra o scorecard
2. Selecione "Ferramentas" > "Exportar valores dos indicadores"
3. Siga os passos para chegar na página "Pré-visualizar resultados de exportação"
4. A coluna "GUID" na tabela de pré-visualização conterá o GUID do KPI

Escrevendo e Lendo valores utilizando a API

Utilize o KPI Value Controller para escrever e ler os dados para os KPI.

• Lembre-se de utilizar o token no cabeçalho dos pedidos
• As datas devem ter o formato aaaa-MM-dd(por exemplo "2017-06-30")
• Os dados são enviados e recebidos no formato JSON
• Para otimizar os números das chamadas utilize as chamadas em lote
• Para ler valores agrupados, calculados ou herdados utilize o Grouped Values Controller

Verifique o exemplo.php em relação à utilização da API.