API's de Extracción de datos

Introducción

Esta sección explica cómo extraer datos de la plataforma Gear Studio utilizando la API HTTP, como por ejemplo:

• Alertas: la API permite extraer la definición de todas las alertas creadas en la plataforma, filtrándolas de diferentes formas.
• Alarmas: la API permite extraer todas las alarmas registradas en la plataforma, en forma histórica, filtrándolas de diferentes formas.
• Datos de endpoints: la API permite extraer toda la información asociada a los endpoints, en forma histórica, filtrándola de diferentes formas.
• Geozonas: la API permite extraer la lista de geozonas configuradas para cada cliente, incluyendo la lista de vehículos contenidos en ellas.

Primeros pasos

Creación de un access token

Al igual que con cualquier otra integración por HTTP, será necesario crear un token de acceso (access token). Esta página contiene más información sobre la administración de tokens de acceso. Los access tokens permiten controlar el acceso y los permisos utilizados para cualquier operación. 

Autentificación mediante un access token

En todas las APIs es posible enviar el access token como parte del encabezado, utilizando un encabezado Authorization, como se ve a continuación:

Authorization: Bearer e54e0911-ece3-4b7a-b84d-afc01dfa81f1

Alternativamente, cuando no es posible enviar el token a través del encabezado Authorization, el access token puede enviarse como parte de la url, a través del parámetro “accessToken”, como en el siguiente ejemplo:

https://gear.cloud.studio/api/v2/alarms?accessToken=e54e0911-ece3-4b7a-b84d-afc01dfa81f1&clientID=4&maxCount=10

Ejecución de la API

Para ejecutar la API, revise cada una de las secciones siguientes, que contienen la información relacionada:

• Extracción de alertas.
• Extracción de alarmas.
• Extracción de datos de endpoints.
• Extracción de datos de geozonas.