Desarrolladores

API de taquillas inteligentes y webhooks

Todo lo que la consola de administración hace con los paquetes está disponible a través de una API REST versionada en /api/v1, documentada en OpenAPI.

API REST

01

Taquillas

Consulte las taquillas con compartimentos libres por tamaño. Las taquillas de otros fabricantes se marcan como externas y de solo lectura.

02

Paquetes

Cree entregas y envíos, asigne un paquete a un repartidor o al grupo compartido, cancele y consulte los paquetes pendientes de recoger.

03

Seguimiento y prueba de entrega

Lea los eventos de seguimiento que informa la taquilla y la cadena de eventos con hash de un paquete, con las fotos y notas del repartidor.

04

Reservas

Reserve un compartimento de tamaño S, M o L para una franja horaria. El paquete creado con la reserva recibe ese compartimento.

05

Devoluciones

Cree una devolución para un paquete y reciba el código de devolución.

06

Token de carga para repartidores

Obtenga un token de carga firmado para su propia aplicación de repartidores.

Claves y límites

Las claves API se crean en la consola de administración solo con los permisos necesarios, como parcels:read o parcels:write. Las claves se almacenan como hashes. Cada clave está limitada a 10 peticiones por segundo.

Webhooks

Suscríbase desde la consola de administración o mediante la API. Eventos: alert.opened, alert.resolved, parcel.created, parcel.status_changed, workorder.changed.

01

Firmados

Cada petición incluye una marca de tiempo y una firma HMAC-SHA256 calculada sobre la marca de tiempo y el cuerpo. Rechace cualquier petición con más de 5 minutos de antigüedad.

02

Enviados una vez guardado el cambio

Un outbox transaccional envía un evento si y solo si el cambio se ha confirmado. Las entregas fallidas se reintentan.

03

Destinos seguros

Solo HTTPS, sin redirecciones y con las direcciones privadas y especiales bloqueadas al conectar. Compatible con Slack o Teams.

Widget de selección de taquilla

Añada /widget/lockers.js a su página de pago para mostrar las taquillas con compartimentos libres. Lee una lista pública de taquillas de cada operador, por lo que no se expone ninguna clave API en el navegador.

Documentación OpenAPI

Cada endpoint, esquema y permiso se describe en un archivo OpenAPI disponible en /api/docs en cada instalación. A partir de él puede generar un cliente en su lenguaje.

Mostrar taquillas de otros fabricantes

Si opera taquillas en la nube de otro fabricante, publíquelas como una lista JSON sencilla: id, nombre, dirección, coordenadas, indicador de conexión y compartimentos libres por tamaño. Lokkio la consulta cada 5 minutos y las muestra en modo de solo lectura.

Contrato entre taquilla y nube

Las taquillas se comunican con la nube mediante mTLS, con un certificado por taquilla. Los eventos se envían en orden. La nube verifica la cadena de hashes y confirma cada lote. El contrato de mensajes está versionado y documentado.

Solicite una clave de sandbox

Pruebe la API con la taquilla de demostración o pídanos una clave para su proyecto de integración.