Developers
One API for everything integrations may do, and nothing more
BatteryPass describes its interface in an OpenAPI contract. Integrations read data, report condition data and stage imports; approving and publishing stay with people.
Interfaces
What the API offers
REST with an OpenAPI contract
JSON over HTTPS, a published OpenAPI contract, errors as Problem Details with stable codes, cursor pagination.
Organisation keys
Keys with the scopes read, condition and import, limited to 600 requests per minute per organisation.
Import by key
An ERP stages CSV or Excel files; members review, take over and approve them.
Change feed
A gap-free feed with a cursor reports changes to models, units and passports for polling.
Public passport reads
GS1 Digital Link resolver, the public tier as JSON, signatures that verify offline with published keys.
MCP server
The published operations as tools for AI clients, with the same keys and scopes.
Principles
What integrations may not do
No approval without people
Keys do not write declared data directly, approve nothing and publish nothing. Imports by key wait for members.
Everything in the log
Every change through the API appears in the organisation's log with the key as the actor.
Documentation
Read the documentation
Getting started, concepts, guides for ERP workflows and the complete API reference are available to signed-in customers in the application, in German and English.
Frequently asked questions from developers
Where is the documentation?
In the application, after signing in: getting started, concepts, guides, recipes and an API reference with a playground, in German and English.
Which scopes do API keys have?
Three: read to read models, units, values and passports, condition to report condition data and import to stage imports. A key is shown once and can be revoked at any time.
Are there webhooks?
Not yet. Integrations poll the change feed; outbound webhooks are planned.
Which AI clients does the MCP server support?
Clients that connect with an API key, such as Claude Code, Cursor or VS Code. Clients that only support OAuth are not supported yet.