La funcionalidad de External API de la Plataforma IOK permite integrar sus equipos, menús, recetas y datos operativos con sistemas externos, ERPs, dashboards, aplicaciones propias, plataformas de BI y otras soluciones desarrolladas por su empresa.

Con ella, es posible automatizar procesos, consumir datos de la plataforma en tiempo real e incluso conectar equipos directamente vía API, dependiendo de la necesidad de la operación.

Requisitos previos

Antes de utilizar los recursos de API, es necesario:

1. Poseer una cuenta activa en la Plataforma IOK
2. Estar vinculado a una empresa en la plataforma
3. Tener acceso a los equipos y menús que desea utilizar

En caso de no tener acceso aún:

• Sepa cómo crear una cuenta:
  Plataforma IOK - Pestaña Login
• Sepa cómo invitar usuarios a una empresa existente:
  Plataforma IOK - Pestaña Usuarios

Recomendación importante

Para aprovechar mejor los recursos de la API, recomendamos que su cuenta ya posea:

• Equipos registrados
• Menús creados
• Grupos y recetas configurados

Artículos relacionados:

• Equipos:
  Plataforma IOK - Pestaña Equipos
• Menús:
  Plataforma IOK - Pestaña Mis Menús

Observación:
También es posible conectar equipos directamente a la Plataforma IOK utilizando la propia API.

Cómo habilitar el modo Desarrollador y generar el Token

Después de iniciar sesión en la Plataforma IOK:

1. Haga clic en su nombre de usuario en la esquina superior derecha
2. Seleccione la opción "Editar Cuenta"
3. Haga clic en "Token Desarrollador"

Se mostrará una ventana solicitando la contraseña actual de la plataforma.

4. Ingrese su contraseña
5. Haga clic en "Confirmar"

Tras la confirmación, el modo Desarrollador se habilitará y se generará un Token de Desarrollador.

Importante:
Este token se utiliza para autenticar las solicitudes realizadas vía API. Recomendamos mantenerlo seguro y no compartirlo con terceros.

Copiando el Token de Desarrollador

Después de la generación:

1. Copie el token mostrado en pantalla
2. Utilice este token en las autenticaciones de las solicitudes de la API

Este token debe ser enviado en los headers de las llamadas realizadas a los endpoints de la plataforma.

Accediendo a la documentación de la API

Después de habilitar el modo Desarrollador, una nueva opción llamada "API Externa" aparecerá en el menú lateral de la Plataforma IOK.

Al acceder a esta opción, será dirigido a la documentación interactiva de la API.

En esta página es posible:

• Visualizar todos los endpoints disponibles
• Entender los parámetros de cada solicitud
• Consultar ejemplos de payloads
• Probar solicitudes directamente desde el navegador
• Validar integraciones antes de la implementación final

Cómo autenticar las solicitudes

En la documentación de la API:

1. Haga clic en el botón "Authorize"
2. Ingrese el Token de Desarrollador
3. Confirme la autenticación

Después de esto, las solicitudes realizadas dentro de la documentación usarán automáticamente el token ingresado.

Consultando equipos conectados

Si desea trabajar con datos de los equipos conectados a su cuenta, el siguiente endpoint es uno de los más importantes:

GET /equipmentList

Devuelve la lista de equipos vinculados a la empresa, incluyendo sus respectivos IDs.

Los IDs de los equipos se utilizan en varios endpoints de la API.

Cómo encontrar el ID de un equipo

Además del endpoint GET /equipmentList, también es posible localizar el ID directamente en la plataforma:

1. Acceda a la pestaña "Equipos"
2. Seleccione el equipo deseado
3. Abra el dashboard individual del equipo

El ID se mostrará en la información del equipo.

Ejemplos de uso de la API

Con la External API de la Plataforma IOK, su empresa puede:

• Integrar equipos con sistemas propios
• Automatizar el envío de menús y recetas
• Desarrollar dashboards personalizados
• Crear integraciones con ERPs y CRMs
• Monitorear telemetría y eventos
• Automatizar actualizaciones de software
• Consolidar datos operativos en herramientas de BI
• Desarrollar aplicaciones personalizadas para la operación

Observaciones importantes

• Cada token tiene un límite de solicitudes por minuto
• El token es individual y está vinculado a la cuenta del usuario
• Recomendamos que las integraciones sean desarrolladas por profesionales del área de tecnología
• Algunas funcionalidades pueden variar según el modelo del equipo

¿Necesita ayuda?

Si tiene dudas sobre integraciones o uso de la External API de la Plataforma IOK, comuníquese con nuestro equipo de soporte a través de los canales oficiales de atención de Prática.