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.
Encontre abaixo algumas instruções que ajudarão você a começar.
A API irá pedi a chave API ou um token de autorização temporário.
Para criar uma nova chave API siga estes passos:
Usar o parâmetro da Chave API obtida 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
Antes de submeter as chamadas API é necessário obter um token de autorização. Envie os seguintes dados para o endpoint de autenticação:
a resposta em formato JSON irá conter os parâmetros errorMessage e token: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"
}
{
"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
As chamadas API relacionadas com o KPI exigem o ID do scorecard e o GUID do KPI.
O ID do Scorecard pode ser encontrado utlizando a chamada API ou manualmente. Para encontrar manualmente o ID do Scorecard:
O GUID de um KPI pode ser encontrado utilizando a chamada API ou manualmente. Para encontrar manualmente o GUID:
Utilize o KPI Value Controller para escrever e ler os dados para os KPI.
Verifique o exemplo.php em relação à utilização da API.