Envíosperros
Administra tus envíos en Envíosperros a través de nuestra integración API para una experiencia más personalizada, ideal para uso interno dentro de una empresa o facilitar los envíos a tus clientes dentro de México.
Autenticación
Para autenticar todas las solicitudes con la API es necesario incluir un Bearer token, el cual se encuentra en la tarjeta de "Conexión via API REST", en la sección de Integraciones en la plataforma.
Este token no expira y puede ser renovado en la misma sección si se pierde o sospecha que se ha vulnerado. Para autenticar cada solicitud HTTP, anexa el encabezado Authorization: Bearer <token>.
Dependiendo si se accede al entorno de pruebas (https://staging-app.enviosperros.com) o al entorno productivo (https://app.enviosperros.com) es
que las API Keys visualizadas dentro de la sección de Integraciones será del
Formato
Se utiliza JSON como formato estándar de solicitud y respuesta (para los endpoints con cuerpo de solicitud), por lo que es necesario incluir los headers Content-Type: application/json y Accept: application/json. Para los endpoints que devuelven archivos binarios (obtener guía y póliza de seguro), el archivo es devuelto codificado en base 64, dentro de la respuesta.
Flujo general
POST /rates: Cotizar un envío usando el endpoint respectivo. Es importante consultarlo con frecuencia para obtener los últimos precios.GET /locations: Obtener el nombre de la colonia deseada en Sepomex, ya que pueden diferir de las listadas
en otros lugares; el cual deberá ser usado textualmente en el siguiente paso.POST /labels: Generar la guía indicando datos del paquete, origen y destino, y opcionalmente de seguro. Los datos del endpoint de ubicaciones son usados tanto en origen como destino. Este endpoint retorna el número de rastreo de la guía generada.GET /labels/{trackingNumber}/download: Descargar la etiqueta en formato PDF, codificado en Base64.POST /labels/{trackingNumber}/pickup: Opcionalmente, agendar la recolección en la dirección de origen, si el servicio lo permite.GET /labels/{trackingNumber}/tracking: Consumiendo el servicio de rastreo bajo demanda podrás saber el estatus actual de tus envíos.
Límites
Esta API cuenta con un límite de 500 llamadas por minuto. Consulta tu límite restante a través de los headers x-ratelimit-limit
y x-ratelimit-remaining, anexos en cada respuesta. Recomendamos espaciar las solicitudes al endpoint de rastreo para evitar bloqueos por límites.
Descuentos
Consulta con tu asesor de ventas de Envíosperros para obtener un código de descuento según tu volumen de envíos, para usarlo dentro de la app y la API.
Saldo
Se requiere saldo en la cuenta asociada al API token utilizado únicamente para generar guías. En ambiente staging, puedes obtener saldo de prueba en 2 puntos: 1) después de registrarte obtendrás saldo automáticamente y 2) después de validar tu identidad en este entorno. Este saldo no es transferible al entorno de producción.
Si requieres de más saldo para continuar haciendo pruebas en ambiente staging, envía un correo a [email protected].
Kit de pruebas HTTP
Para agilizar tu integración vía API, contamos con un kit de requests listo para consumir en Insomnia, disponible aquí. Además, puedes realizar pruebas en ambos ambientes en este mismo sitio anexando tu API token e interactuando con cada uno de los endpoints en la sección de API Reference.
Updated about 1 month ago