Introducción a las REST APIs de KSI VISION

Qué es una REST APIs? Introducción a las REST APIs de KSI VISION

Una REST APIs es una interfaz de programación de aplicaciones, en resumen es un conjunto de reglas que permite que los programas se comuniquen entre sí, exponiendo datos y funcionalidades de una plataforma. REST significa Transferencia de Estado Representacional. Es un patrón arquitectónico que describe como un programa expone su interfaz.

De modo simplificado, cuando se menciona "Rest APIs" generalmente se refiere a una API a la que se accede a través del protocolo HTTP con un conjunto de URLs.

A continuación, se describe en el siguiente artículo, los conocimentos necesarios a modo de introducción a las REST APIs de KSI VISION.

Trabajando con la APIs de KSI

Bearer Authentication

Bearer Authentication (también llamado token de autenticación) es un esquema de autenticación por HTTP que involucra tokens de seguridad. Puede ser entendido como "dar acceso al portador de este token". El token es un código críptico generado por un servidor, el cual se retorna a usuarios que hayan realizado previamente un inicio de sesión. El cliente debe enviar este token en el encabezado de autorización cuando realiza solicitudes a recursos bajo permisos.

Para ver cómo obtener su token en la plataforma ver Autenticación para acceder a las herramientas de desarrollo.

Explorando la APIs

Para acceder a la documentación de la APIs de KSI es necesario iniciar sesión en la plataforma y luego ingresar a la siguiente URL: https://la.ksivision.com/api/docs. (https://eu.ksivision.com/api/docs en Europa) Aquí se podrán visualizar todos los recursos disponibles, sus datos de entrada y salida.

Ejemplo de utilización:

Solicitud de Locations a los que tengo acceso (debes conseguir un API_TOKEN previamente, ver aquí):

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

Respuesta:

Una lista de Locations con sus respectivo ids y descripciones:

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