Introducción

¿Qué es una API?

Una API (Interfaz de Programación de Aplicaciones, por sus siglas en inglés) es un conjunto de reglas que permiten a diferentes aplicaciones comunicarse entre sí. Las APIs hacen posible que los servicios puedan conectarse e intercambiar información de forma eficiente.

¿Qué es un API Partner?

Un api partner se entiende como un cliente corporativo de Ridery para empresas al cual se la ha otorgado acceso y permisos para uso y disfrute de la API

¿Por qué la API de Ridery para empresas?

Nuestra API proporciona una manera simple y eficiente de interactuar con nuestro sistema para realizar operaciones como:

• Consultar datos en tiempo real
• Crear, actualizar o eliminar información de manera segura
• Realizar solicitudes de viaje en Ridery

Requisitos para usar la API

Para comenzar a utilizar esta API, necesitarás:

1. Clave de API, accessos y permisos: Una clave única que permite autenticarse y utilizar los servicios. Puedes obtenerla contactando al equipo Comercial de Ridery.
2. Entorno de Desarrollo: Puedes utilizar herramientas como Postman, Insomnia o cualquier cliente HTTP para enviar solicitudes a la API.
3. Aplicaciones de desarrollo: Debes consultar al equipo Comercial de Ridery sobre las opciones de acceso a aplicaciones de desarrollo para probar tu aplicación.

Balance

Toda creación de viaje/envío depende de que poseas suficiente Balance Corporativo en tu Panel Corporativo para saldar el costo del mismo, si deseas hacer una recarga puedes hacerlo a través del módulo de balance

Importante:

Antes de proceder con cualquier envío utilizando la API de Ridery, es crucial tener en cuenta varias consideraciones previas para asegurar una integración exitosa y el cumplimiento de las políticas de uso. En primer lugar, se recomienda encarecidamente revisar la documentación técnica proporcionada. Esta contiene información detallada sobre los endpoints disponibles, los parámetros que cada uno acepta, y los formatos de respuesta esperados.

Además, es fundamental hacer un uso correcto de la API , no realizar llamadas duplicadas, no saturar los endpoints de la misma, etc.

Por último, se aconseja realizar pruebas en un entorno de desarrollo antes de pasar a producción. Esto incluye verificar la correcta manipulación de errores, la validación de datos de entrada, y la implementación de mecanismos de reintento adecuados y mesurados. Prepararse de antemano para gestionar estos aspectos puede marcar la diferencia en la fiabilidad y la eficiencia de las integraciones con la API de Ridery.

Otro punto a destacar es que la API pudiera sufrir cambios, que serían posteriormente notificados en esta documentación.

Igualmente es importante mantener la confidencialidad de este documento entero