Entwickler

Paketautomat API und Webhooks

Alles, was die Admin-Konsole mit Sendungen tun kann, steht auch über eine versionierte REST-API unter /api/v1 bereit, dokumentiert in OpenAPI.

REST-API

01

Automaten

Automaten mit freien Fächern nach Größe auflisten. Automaten anderer Hersteller sind als fremd markiert und nur lesbar.

02

Sendungen

Zustellungen und Einlieferungen anlegen, eine Sendung einem Zusteller oder dem gemeinsamen Pool zuweisen, stornieren und abzuholende Sendungen auflisten.

03

Tracking und Nachweis

Vom Automaten gemeldete Tracking-Ereignisse lesen, dazu die per Hash verketteten Ereignisse einer Sendung mit Fotos und Notizen des Zustellers.

04

Reservierungen

Ein Fach der Größe S, M oder L für ein Zeitfenster reservieren. Eine mit der Reservierung angelegte Sendung erhält genau dieses Fach.

05

Retouren

Eine Retoure für eine Sendung anlegen und den Retourencode erhalten.

06

Ladetoken für Zusteller

Ein signiertes Ladetoken für Ihre eigene Zusteller-App abrufen.

Schlüssel und Limits

API-Schlüssel werden in der Admin-Konsole angelegt, nur mit den Scopes, die Sie brauchen, etwa parcels:read oder parcels:write. Schlüssel werden als Hash gespeichert. Jeder Schlüssel ist auf 10 Anfragen pro Sekunde begrenzt.

Webhooks

Abonnieren Sie in der Admin-Konsole oder über die API. Ereignisse: alert.opened, alert.resolved, parcel.created, parcel.status_changed, workorder.changed.

01

Signiert

Jede Anfrage enthält einen Zeitstempel und eine HMAC-SHA256-Signatur über Zeitstempel und Body. Verwerfen Sie alles, was älter als 5 Minuten ist.

02

Zugestellt, sobald die Änderung gespeichert ist

Eine transaktionale Outbox sendet ein Ereignis genau dann, wenn die Änderung festgeschrieben ist. Fehlgeschlagene Zustellungen werden wiederholt.

03

Sichere Ziele

Nur HTTPS, keine Weiterleitungen, private und spezielle Adressen werden beim Verbindungsaufbau blockiert. Funktioniert mit Slack oder Teams.

Widget zur Automatenauswahl

Binden Sie /widget/lockers.js in Ihre Checkout-Seite ein, um Automaten mit freien Fächern anzuzeigen. Das Widget liest eine öffentliche Automatenliste pro Betreiber, im Browser wird also kein API-Schlüssel offengelegt.

OpenAPI-Dokumentation

Jeder Endpunkt, jedes Schema und jeder Scope ist in einer OpenAPI-Datei beschrieben, die jede Installation unter /api/docs bereitstellt. Daraus generieren Sie einen Client in Ihrer Sprache.

Automaten anderer Hersteller anzeigen

Betreiben Sie Automaten in der Cloud eines anderen Herstellers, stellen Sie diese als einfache JSON-Liste bereit: ID, Name, Adresse, Koordinaten, Online-Status und freie Fächer nach Größe. Lokkio liest die Liste alle 5 Minuten ein und zeigt die Automaten schreibgeschützt an.

Schnittstelle zwischen Automat und Cloud

Automaten kommunizieren mit der Cloud über mTLS, mit einem eigenen Zertifikat pro Automat. Ereignisse werden in fester Reihenfolge übertragen. Die Cloud prüft die Hash-Kette und bestätigt jeden Batch. Das Nachrichtenformat ist versioniert und dokumentiert.

Sandbox-Schlüssel anfordern

Testen Sie die API mit dem Demo-Automaten oder fordern Sie einen Schlüssel für Ihr Integrationsprojekt an.