Entwickler
Eine API für alles, was Integrationen dürfen, und nicht mehr
BatteryPass beschreibt seine Schnittstelle in einem OpenAPI-Vertrag. Integrationen lesen Daten, melden Zustandsdaten und stellen Importe bereit; freigeben und veröffentlichen bleibt bei Menschen.
Schnittstellen
Was die API bietet
REST mit OpenAPI-Vertrag
JSON über HTTPS, ein veröffentlichter OpenAPI-Vertrag, Fehler als Problem Details mit festen Codes, Seiten mit Cursor.
Organisationsschlüssel
Schlüssel mit den Bereichen read, condition und import, je Organisation begrenzt auf 600 Anfragen pro Minute.
Import per Schlüssel
Ein ERP stellt CSV- oder Excel-Dateien bereit; Mitglieder prüfen, übernehmen und geben frei.
Änderungs-Feed
Ein lückenloser Feed mit Cursor meldet Änderungen an Modellen, Einheiten und Pässen zum Abfragen.
Öffentliche Passabrufe
GS1-Digital-Link-Resolver, öffentliche Ebene als JSON, Signaturen mit veröffentlichten Schlüsseln offline prüfbar.
MCP-Server
Die veröffentlichten Operationen als Werkzeuge für KI-Clients, mit denselben Schlüsseln und Bereichen.
Grundsätze
Was Integrationen nicht dürfen
Keine Freigabe ohne Menschen
Schlüssel schreiben keine erklärten Daten direkt, geben nichts frei und veröffentlichen nichts. Importe per Schlüssel warten auf Mitglieder.
Alles im Protokoll
Jede Änderung über die API erscheint mit dem Schlüssel als Handelndem im Protokoll der Organisation.
Dokumentation
Die Dokumentation lesen
Einstieg, Konzepte, Anleitungen für ERP-Abläufe und die vollständige API-Referenz stehen angemeldeten Kunden in der Anwendung zur Verfügung, auf Deutsch und Englisch.
Häufige Fragen von Entwicklern
Wo finde ich die Dokumentation?
In der Anwendung, nach der Anmeldung: Einstieg, Konzepte, Anleitungen, Rezepte und eine API-Referenz mit Testumgebung, auf Deutsch und Englisch.
Welche Bereiche gibt es für API-Schlüssel?
Drei: read zum Lesen von Modellen, Einheiten, Werten und Pässen, condition zum Melden von Zustandsdaten und import zum Bereitstellen von Importen. Ein Schlüssel wird einmal angezeigt und lässt sich jederzeit widerrufen.
Gibt es Webhooks?
Noch nicht. Integrationen fragen den Änderungs-Feed ab; ausgehende Webhooks sind geplant.
Welche KI-Clients unterstützt der MCP-Server?
Clients, die sich mit einem API-Schlüssel verbinden, etwa Claude Code, Cursor oder VS Code. Clients, die nur OAuth beherrschen, werden noch nicht unterstützt.