Changelog
What changed in the integration API and in this documentation.
New entries are at the top. The history is also available as an RSS feed.
Integrations can now bring units in and follow changes without scanning everything.
- A third key scope,
import: a key with it uploads, maps and validates spreadsheet imports of units (createImport,getImport,listImports,updateImportMapping,validateImport). Committing the import and approving its values stay with members in the portal. An import staged with a key names it increated_by_api_key;created_byis then absent. - Import presets:
presetoncreateImportandupdateImportMappingmaps the columns of a known ERP export by their headers. - The change feed
listChanges(scoperead): the organisation's changes oldest first, without values, actors or personal data, safe to poll with a stored cursor. - New integration guides: the security model, five workflows, iPaaS, standards and a page per ERP system from the ERP registry, with how and when each interface was checked.
The developer documentation moves to /docs/ and replaces the former /api-docs page (which now redirects to
the API reference).
- Getting started, concepts, guides and recipes in German and English.
- The API reference is generated from the published contract, with a playground, code samples in cURL, JavaScript, Python and Go, and the contract to download (JSON, YAML).
- Every page is available as Markdown (the page's address plus
.md), along withllms.txtandllms-full.txtfor language models.
Addresses follow the format of their European country. All changes are compatible.
Addressgainsextra_line(the second address line: building, floor, c/o) andregion(the administrative area, where the country's format has one). Both are optional and appear in the facilities oflistFacilitiesand in the operator's public profile in passports.listFacilitiesalso returnsplace_idandconfirmed_source: how a member entered the address (by hand, from the address search or confirmed by the address check). They never appear in signed snapshots or public passports.- The new problem code
address_lookup_unavailable(503) belongs to the portal's address search, which does not accept API keys.
Only the part of the contract that integrations can use is published now: the 32 operations that accept an API
key and the 5 public passport reads. Sign-in, sessions, key management and every other portal operation are no
longer in /api/v1/openapi.json and .yaml; they may change without notice.
- Organisation API keys (
Authorization: Bearer bp_live_…) with the scopesreadandcondition. Owners create keys in the portal; a key has a viewer's rights. - With
condition, battery management systems and service partners report condition data (updateCondition) and lifecycle events (createLifecycleEvent). - Limits: 600 requests per minute for all keys of an organisation together, 30 attempts per 15 minutes for
unknown keys, 300 public reads per minute and address;
429withRetry-After.