Consignes
Listez les consignes avec leurs casiers libres par taille. Les consignes d'autres fabricants sont marquées comme externes et en lecture seule.
Développeurs
API consigne colis et webhooks
Tout ce que la console d'administration fait avec les colis est disponible via une API REST versionnée sous /api/v1, documentée en OpenAPI.
API REST
Colis
Créez des livraisons et des envois, attribuez un colis à un livreur ou au pool partagé, annulez, et listez les colis à collecter.
Suivi et preuves
Consultez les événements de suivi remontés par la consigne, ainsi que les événements chaînés par hash d'un colis, avec les photos et notes du livreur.
Réservations
Réservez un casier de taille S, M ou L sur un créneau. Un colis créé avec la réservation reçoit ce casier.
Retours
Créez un retour pour un colis et recevez le code de retour.
Jeton de dépôt livreur
Obtenez un jeton de dépôt signé pour votre propre application livreur.
Clés et limites
Les clés API sont créées dans la console d'administration avec uniquement les portées nécessaires, comme parcels:read ou parcels:write. Les clés sont stockées sous forme de hash. Chaque clé est limitée à 10 requêtes par seconde.
Webhooks
Abonnez-vous dans la console d'administration ou via l'API. Événements : alert.opened, alert.resolved, parcel.created, parcel.status_changed, workorder.changed.
Signés
Chaque requête contient un horodatage et une signature HMAC-SHA256 calculée sur l'horodatage et le corps. Rejetez toute requête de plus de 5 minutes.
Envoyés une fois la modification enregistrée
Une outbox transactionnelle envoie un événement si et seulement si la modification est validée. Les envois échoués sont relancés.
Destinations sûres
HTTPS uniquement, sans redirection, adresses privées et spéciales bloquées à la connexion. Compatible avec Slack ou Teams.
Widget de sélection de consigne
Ajoutez /widget/lockers.js à votre page de paiement pour afficher les consignes avec casiers libres. Il lit une liste publique de consignes propre à chaque exploitant : aucune clé API n'est exposée dans le navigateur.
Documentation OpenAPI
Chaque endpoint, schéma et portée est décrit dans un fichier OpenAPI servi à l'adresse /api/docs sur chaque installation. Vous pouvez en générer un client dans votre langage.
Afficher les consignes d'un autre fabricant
Si vous exploitez des consignes sur le cloud d'un autre fabricant, exposez-les sous forme d'une simple liste JSON : identifiant, nom, adresse, coordonnées, indicateur en ligne et casiers libres par taille. Lokkio la lit toutes les 5 minutes et les affiche en lecture seule.
Contrat entre consigne et cloud
Les consignes communiquent avec le cloud en mTLS, avec un certificat par consigne. Les événements sont envoyés dans l'ordre. Le cloud vérifie la chaîne de hachage et accuse réception de chaque lot. Le contrat de messages est versionné et documenté.
Obtenir une clé sandbox
Testez l'API sur la consigne de démonstration, ou demandez-nous une clé pour votre projet d'intégration.