Automatizar la entrada de datos de KPIs con RESTFul API

Automatice la lectura y escritura de datos para KPIs con RESTFull API. Automatice el acceso a sus datos para herramientas de negocios de terceros.

Información general

• Documentación. La documentación de las llamadas a la API está disponible aquí.
• Webhooks. Las alertas en BSC Designer pueden ser configuradas para emitir webhooks.
• Limitaciones. La API sólo puede ser utilizada por el propietario de la cuenta. Una cuenta tiene un límite de 100 llamadas de API por hora por usuario experto.

Empezando

A continuación, usted encontrará algunas instrucciones que le ayudarán a empezar.

Token de autorización

Antes de enviar las llamadas API, es necesario obtener un token de autorización. Envíe los siguientes datos al punto de acceso final:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

{

"email": "reemplazar_por_email_aquí",

"contraseña": "reemplazar_con_contraseña_de_acceso"

}

La respuesta en formato JSON contendrá parámetros errorMessage y token:

{

"email": "string",

"errorMessage": "string",

"success": true,

"token": "string"

}

Usar el parámetro tokenobtenido en los encabezados de todas las demás llamadas a la API:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

Token: replace_with_obtained_token

Obteniendo identificaciones para el Cuadro de Mando y el KPI

Las llamadas API relacionadas con el KPI requieren el ID del Cuadro de Mando y el GUID del KPI.

Obtener ID de Cuadro de Mando

El ID de Cuadro de Mando se puede encontrar usando llamada API o manualmente. Para encontrar manualmente el ID de Cuadro de Mando:

1. Vaya a la sección Mis proyectos
2. Abra el cuadro de mandos destino
3. La URL del cuadro de mando será algo así: https://www.webbsc.com/s/123456
4. El número al final es el ID del Cuadro de Mando

Obtención de KPI GUID

El GUID de KPI se puede encontrar usando llamada API o manualmente. Para encontrar GUID manualmente:

1. Abra el cuadro de mando
2. Seleccione Herramientas > Exportar valores de indicador
3. Siga los pasos para ir a la página Pre visualizar resultados de exportación
4. La columna GUID de la tabla de vista previa contendrá GUID del KPI

Escribir y leer valor utilizando API

Utilice Controlador de valor KPI para escribir y leer datos para los KPI.

• Recuerde utilizar token en el encabezado de las solicitudes
• Las fechas deben estar en el formato aaaa-MM-dd (por ejemplo "2017-06-30")
• Los datos se envían y reciben en formato JSON
• Para optimizar los números de llamada, utilice llamadas por lotes
• Para leer valores agrupados, calculados o heredados, utilice Controlador de valores agrupados

Eche un vistazo al ejemplo php de uso de API.