Introducción a las REST APIs de KSI Vision

¿Qué es una REST API?

Una REST API (Transferencia de Estado Representacional) es un conjunto de reglas que permite que los programas se comuniquen entre sí, exponiendo datos y funcionalidades a través de HTTP. Cuando se menciona una REST API, generalmente se refiere a una interfaz web con la que interactúas mediante URLs usando verbos HTTP estándar (GET, POST, etc.).

Las REST APIs de KSI Vision le dan a los desarrolladores acceso directo a las analíticas de la plataforma, datos de configuración e ingesta de eventos - sin necesidad de usar la interfaz web.

Autenticación Bearer

Todas las solicitudes a la API de KSI requieren autenticación mediante un Bearer Token. La autenticación Bearer es un esquema de autenticación HTTP donde un token de seguridad - generado por el servidor al iniciar sesión - debe incluirse en el encabezado Authorization de cada solicitud.

puedes entenderlo así: "dar acceso al portador de este token." El token es criptográfico, está vinculado a una cuenta específica y hereda los permisos de esa cuenta.

Para ver cómo generar tu token, consulta la guía de Autenticación.

Explorando la documentación de la API

Una vez logueado en la plataforma KSI, puedes acceder a la documentación interactiva completa de la API en la siguiente URL:

• Américas: https://la.ksivision.com/api/docs
• Europa: https://eu.ksivision.com/api/docs

La documentación lista todos los endpoints disponibles, sus entradas esperadas y la estructura de sus respuestas.

Ejemplo: obtener tus Locations

La siguiente solicitud devuelve una lista de todos los Locations a los que tiene acceso tu cuenta. Reemplazá API_TOKEN con tu Token de Acceso Personal (ver guía de Autenticación).

curl -H 'Accept: application/json' \
     -H "Authorization: Bearer API_TOKEN" \
     https://la.ksivision.com/api/locations

// Content-Type: application/json
[
  {
    "id": 0,
    "description": "string"
  }
]