API y webhooks para la integración en sistemas externos
Nuestras API están basadas en REST y utilizan json como formato portador. Existe una especificación Open API 3.0.2 para todas nuestras API y webhooks, que nuestros socios integradores pueden utilizar para generar marcos de modelos con comprobaciones de tipos y envoltorios de API para nuestros puntos finales dentro de sus herramientas.
La documentación de la API y los webhooks se genera a partir de estas especificaciones abiertas de la API y se pone a disposición de nuestros socios como parte del programa de desarrolladores de ioki. El programa de desarrolladores de ioki también proporciona acceso a un rastreador de errores compartido y desempeña un papel crucial en la comunicación de los cambios de la API. La documentación se compone de la API Guide, Passenger API, Driver API, Platform API y Webhooks.
API Guide
La API Guide contiene instrucciones para su correcta utilización
Passenger API
Para el desarrollo completo de clientes usuarios de DRT
Driver API
Proporciona todos los elementos necesarios para programar un conductor cliente
Platform API
Interfaz para la integración completa con backends de terceros
Webhooks
Información sobre eventos que tienen lugar en el ecosistema ioki
El programa de desarrolladores
La participación en el programa de desarrolladores de ioki es necesaria para la integración de nuestras API.
Se requiere un NDA (acuerdo de no divulgación) con ioki: dependiendo de su relación con ioki, su gestor de cuentas clave, contacto de ventas o socio técnico estará encantado de guiarle a través de este sencillo proceso. El acuerdo de confidencialidad también es necesario si está realizando un análisis de requisitos o un estudio de viabilidad y necesita revisar la documentación con su equipo. Una vez firmado el acuerdo de confidencialidad, crearemos cuentas para que usted y los miembros de su equipo accedan a nuestra instancia de GitLab para desarrolladores.
Esta cuenta le dará acceso a la documentación más reciente de la API y al rastreador de errores. Somos muy estrictos con este proceso, ya que nuestras API no son públicas y suelen necesitar aclaraciones previas debido a su complejidad. Además, aunque el acceso a la documentación y al rastreador de errores es la parte obvia, el programa para desarrolladores es mucho más que eso. Merece la pena optimizar los procesos !
Las ventajas de un vistazo
- Obtenga acceso a toda nuestra documentación: Directrices API, Passenger API, Driver API, Platform API y Webhook
- Acceso a un gestor de incidencias compartido para estar al día de preguntas, solicitudes e informes de errores
- Asistencia técnica: responsable de la correspondencia con sus equipos de desarrollo
- Acceso a un entorno de desarrollo adaptado a su caso de uso
- Kickoff con un desarrollador ioki para proporcionar valiosos detalles técnicos
- Durante la fase caliente de la integración, apoyamos a su equipo de desarrollo con un vídeo semanal de un desarrollador senior: hemos descubierto que el diálogo regular acelera enormemente el proceso de desarrollo
API Guide
Las API de ioki tienen unos principios de diseño comunes. Algunos ejemplos son: Qué cabeceras son necesarias, cómo funciona la paginación, cómo hace visible la API los errores y muchos otros temas. Algunas partes de esta documentación pueden ser relevantes para la mayoría, pero no necesariamente para todas las APIs, puntos finales y casos de uso.
Passenger API
La Passanger API es la interfaz que permite desarrollar clientes de pasajeros de DRT completos en todas sus variantes. La mayoría de los clientes básicos consisten en una interfaz de usuario bastante sencilla en la que un usuario puede solicitar un viaje de A a B, obtener un resultado simple y reservarlo o rechazarlo. Pero la API ofrece mucho más: reservas inmediatas o futuras en distintas zonas geográficas, información de servicio previa al viaje, valoración, pago, propinas, visualización de la posición del vehículo que se aproxima, detalles de la estación, información sobre peatones, actualizaciones en directo y cálculos de tiempo, viajes pasados y futuros, recibos y mucho más. Puede integrar todas las funciones que hemos diseñado.
Driver API
Esta API expone todas las primitivas para escribir un cliente conductor. Puede tratarse de una simple aplicación con una lista de direcciones y horarios para los conductores, pero, al igual que con la Passanger API, se puede ir a por todas: Consumimos nuestras propias API y proporcionamos un cliente de referencia con un completo sistema de navegación giro a giro, funcionalidad de registro de entrada y salida de pasajeros, que asiste a los conductores desde el momento en que salen del depósito hasta que regresan.
Platform API
Mientras que las Passanger API y Driver API son utilizadas por los clientes que se ejecutan en dispositivos móviles, la Platform API es nuestra interfaz para la plena integración con backends de terceros. Con nuestro producto estándar, nos esforzamos por lograr la paridad funcional y no hay casi ninguna función que no pueda controlarse a través de esta interfaz. Puede crear, modificar o eliminar todo tipo de recursos, por ejemplo, crear nuevas estaciones, reconfigurar su flota, establecer turnos y sincronizar las bases de datos de despliegue. Nuestra plataforma DRT está diseñada para integrarse con todo tipo de flujos de datos y casos de uso. Es posible ejecutar múltiples productos con múltiples clientes e incluso compartir bases de datos de usuarios con diferentes socios de integración. Para casos de uso específicos, la Platform API le permite incluso emitir tokens de acceso para las API de Driver y Passanger si su backend necesita actuar en nombre de pasajeros o conductores específicos.
Webhooks
Los webhooks son una forma común de estar informado sobre los eventos dentro de un sistema. Nuestros webhooks le permiten mantenerse al día de los cambios de estado, facilitando casos de uso sencillos, como la lectura de datos individuales, y otros complejos, como la activación de una lógica por su parte que pueda utilizar las demás API. Los webhooks pueden configurarse manualmente, pero también mediante programación a través de la Platform API. Pueden activarse siempre que ocurra algo o restringirse a determinados eventos. Están protegidos por una firma con un código secreto compartido. Los webhooks no entregados se repiten mediante un algoritmo de backoff exponencial. También es posible recuperar de nuevo los datos perdidos a través de la Platform API. La carga útil del webhook no contiene estructuras de datos infinitamente anidadas (se puede utilizar la Platform API para recuperar datos adicionales si es necesario), pero sin embargo: enviamos una representación serializada completa del objeto asociado al evento. Por tanto, los datos que contiene son suficientes para la mayoría de los casos de uso.
Déjate aconsejar por nuestros expertos
Diseña con nosotros el futuro de la movilidad de tus servicios de transporte o desarrolla nuevas ideas de la mano de nuestros profesionales. Te esperamos.
