Guía de Integración de la API de Zendu Connect

Escrito por Maria Daniela

Visión General

La API pública REST y el SDK de Zendu Connect proporcionan herramientas robustas para automatizar tareas y trabajar con datos de GoZen. GoZen utiliza APIs extensivamente dentro de los sistemas para automatizar procesos y facilitar la comunicación entre componentes. Múltiples APIs permiten a los desarrolladores interactuar con los datos en bruto accesibles en la aplicación ZenduOne, incluyendo dispositivos, transmisiones de video, excepciones y datos de despacho.

Propósito

Esta guía de integración explica cómo utilizar los datos disponibles a través de APIs y SDK para crear interfaces de usuario o integrar datos de GoZen con herramientas existentes.

Primeros Pasos

Configuración del Entorno de Pruebas

La documentación de las APIs de Zendu Connect está disponible en: https://one-api-docs.zenduit.com/#intro

Prueba todas las APIs en Postman haciendo clic en el botón "Run in Postman" en la parte superior derecha de la página de documentación.

Autenticación y Acceso a la API

Credenciales Requeridas

La autenticación requiere el endpoint de Auth (primer endpoint en la documentación de la API) con los siguientes parámetros en el cuerpo de la solicitud:

  • Database: Identificador de la base de datos

  • Username: Credenciales de usuario

  • Password: Credenciales de usuario

Contacta a servicedesk@zenduit.com para obtener los parámetros de autenticación. El endpoint de Auth proporciona un ID de sesión en la respuesta que se debe usar con todos los demás endpoints de la API. El ID de sesión debe regenerarse cada 14 días.

Endpoints Disponibles

Módulos Core

  • Jobs: Operaciones CRUD en el módulo de trabajos y envío de órdenes de trabajo

  • Device: Recuperar información del dispositivo incluyendo estado más reciente

  • Forms: Gestionar formularios incluyendo recuperación y eliminación

  • Products: Operaciones CRUD en el módulo de productos

  • Zone: Operaciones CRUD en ubicaciones

  • Users: Operaciones CRUD en usuarios y funcionalidad de restablecimiento de contraseña

  • Groups: Operaciones CRUD en grupos

Datos y Monitoreo

  • Exception: Recuperar excepciones de dispositivos

  • Logs: Recuperar registros GPS para dispositivos

  • Trips: Recuperar viajes de dispositivos dentro de rangos de fechas especificados

  • Rules: Recuperar todas las reglas configuradas en el sistema

Medios y Almacenamiento

  • Media: Endpoints relacionados con cámaras para transmisiones en vivo, transmisiones históricas, activación de cámara, solicitudes de instantáneas y solicitudes de video

  • Custom Data: Operaciones CRUD en datos personalizados para almacenamiento de pares clave/valor

  • File: Almacenar archivos en la nube y recuperarlos vía URLs proporcionadas

Información de Dispositivos

  • Tracker Types: Recuperar todos los tipos de rastreadores disponibles en ZenduIoT

Casos de Uso de Ejemplo

Obtención de Información de Vehículos

Recuperación autenticada de detalles de dispositivos:

curl --location 'https://one-service.zenduit.com/api/' \
--header 'Content-Type: application/x-www-form-urlencoded' \ 
--data-urlencode 'JSON-RPC={  
"method": "Get",  
"params": {  
"typeName": "Device",  
"search": { 
"deviceSearch": { "id": "deviceId" }  
},  
"credentials": {  
"sessionId": ""  
}  
},  
"type": "trax"  
}'

Acceso a Video en Transmisión en Vivo

Acceso a transmisión en vivo del dispositivo:

curl --location 'https://one-service.zenduit.com/api/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'JSON-RPC={
"method": "Get",
"params": {
"typeName": "LiveMedia",
"search": {  
"device": { "id": "deviceId" }
},
"credentials": {
"sessionId": "sessionId"  
}  
},  "type": "trax"  
}'

Recursos de Desarrollo

SDK

ZenduConnect ofrece un SDK para desarrollo de aplicaciones con funciones para uso directo en aplicaciones JavaScript.

Documentación del SDK: https://www.npmjs.com/package/zen-open-api?activeTab=readme

Instalación:

npm i zen-open-api

Soporte para Desarrolladores

Primeros Pasos

Contacta a servicedesk@zenduit.com para obtener credenciales y comenzar a trabajar con la API de ZenduConnect.

Documentación de la API: https://one-api-docs.zenduit.com/

Soporte Adicional

Para consultas sobre integración, contacta a integrations@zenduit.com para asistencia técnica y orientación en desarrollo.

La diapositiva siguiente ha sido añadida como referencia.