Documentación de la API de StandBy

Bienvenido a la documentación oficial de la API de StandBy. Esta API permite integrar y automatizar los procesos logísticos de última milla para carga ligera y pesada, conectando clientes, operadores y plataformas externas en un mismo ecosistema.

🚀 Introducción

La API de StandBy está diseñada para ofrecer una integración rápida, segura y escalable. Permite crear, obtener, cancelar y rastrear envíos en tiempo real.

🔑 Autenticación

StandBy utiliza OAuth 2.0 (Client Credentials Grant) para la autenticación machine-to-machine. Cada cliente debe solicitar sus credenciales (client_id y client_secret) para obtener un token de acceso válido.

Estas credenciales se obtienen a través del portal de desarrolladores de StandBy.

Los pasos para obtener las credenciales son:

  1. Registrarse o iniciar sesión en el Sitio Oficial de StandBy.
  2. Navegar a la sección de “Perfil” en la barra superior.
  3. Deslizar a la sección de “Llaves de acceso” y clicar en “Administrar llaves”.
  4. Crear una nueva llave de acceso clicando en “Generar nueva llave” y copiar el client_id y client_secret generados, guárdalos en un lugar seguro ya que el client_secret no se mostrará nuevamente.

🤝 Servicios Disponibles

La API de StandBy ofrece una variedad de recursos para gestionar diferentes aspectos de la logística de última milla. A continuación se describen los principales recursos disponibles:

  • Autenticación: Manejo de tokens de acceso (JWT), este token debe ser incluido en el header de Authorization de cada solicitud usando Bearer {token} este token expira en 8 horas por lo que es necesario renovarlo periódicamente. Ademas de que el tiempo de expiración puede cambiar sin previo aviso, por lo que recomendamos siempre manejar la renovación del token de acceso en tu aplicación. (Ejemplo)
  • Cotización de envíos: Obtención de precio de un envío. (Ejemplo)
  • Creación de envíos: Creación de un nuevo envío. (Ejemplo)
  • Cancelación de envíos: Cancelación de un envío existente. (La cancelación puede estar sujeta a políticas específicas). (Ejemplo)
  • Listado de envíos: Consulta de todos los envíos realizados con tu cuenta. (Ejemplo)
  • Detalle de envío: Consulta de información detallada de un envío específico. (Ejemplo)

La documentación completa de cada recurso, incluyendo endpoints, métodos HTTP, parámetros y ejemplos de solicitudes y respuestas, está disponible en la sección de Documentación de la API.