Arendajad
Kaks API-t
Akupasside haldamise API
/openapi.jsonAkupasside omanikust ettevõttele: loetlege mudeleid ja kirjeid (kursoriga, sünkroniseerimiseks updatedSince), looge kirjeid, vahemikke ja mudelite koopiaid, uuendage kirje andmeid, avaldage (üks kirje või taustal) ja hankige QR-koode. Autentimine API võtmega.
Viide: Akupasside haldamise APIDPP API (EN 18222)
/openapi-dpp.jsonElutsükli ja täppisgranulaarsuse API, mis järgib standardit EN 18222: lugege akupasse oma juurdepääsutasemel, otsige akupassi ID-sid toote ID järgi, registreerige sündmusi (remont, seisukord, olek) OAuth 2.0 juurdepääsutunnusega. Avalikke andmeid saab lugeda ilma tunnuseta.
Viide: DPP API (EN 18222)
Lugege akupassi
Iga akupassi aadress vastab JSON-iga, kui seda küsite – avalike andmete jaoks pole võtit vaja. Päised sisaldavad versiooni, selle SHA-256 ja Ed25519 allkirja, nii et saate loetut meie avalike võtmete vastu kontrollida.
curl -i -H "Accept: application/json" \https://batterycompliance.eu/id/BG123456789/EBIKE-48V/SN0001 HTTP/1.1 200 OKContent-Type: application/json; charset=utf-8X-Passport-Version: 3X-Passport-Access-Level: publicX-Passport-SHA256: bd4c49c7b04ac463…81146b938X-Passport-Signature: Tw0bRkvf+s3IS1MQ…MPZ7Dg==X-Passport-Key-Id: batterycompliance-2026-09-25Link: </schema/battery-passport/2.0.0>; rel="describedby" { "dppHeader": { "dppStatus": { "dppStatusValue": "active" }, … }, "identifiersAndProductData": { "batterySerialNumber": "SN0001", … }, … }Kuidas API-d töötavad
Autentimine
API võtmed loob ettevõtte omanik jaotises Company → API keys ja neid näidatakse üks kord. Saatke need kujul Authorization: Bearer bcp_live_…. Skoobid: items:read, items:write (ka lugemine), items:publish, qr:read.
OAuth 2.0 kliendid (client credentials) loob ettevõtte omanik oma partneritele või platvorm ametiasutustele ja kinnitatud kolmandatele isikutele. Hankige tunnus päringuga POST /oauth/token (grant_type=client_credentials); see kehtib 15 minutit. Skoobid: dpp:read, dpp:search, dpp:write.
Limiidid ja vead
60 päringut minutis API võtme kohta (päised X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) ja 120 minutis OAuth kliendi kohta või, ilma tunnuseta, aadressi kohta. Limiidi ületamisel: HTTP 429 koos päisega Retry-After.
Akupasside haldamise API vastab vigadele objektiga error, mis sisaldab välju code, message ja details; DPP API vastab väljadega statusCode, payload ja result standardi EN 18222 olekukoodidega.
DPP API uuendused aktsepteerivad päist Idempotency-Key: sama võti sama päringuga 24 tunni jooksul tagastab esimese vastuse ega loo teist versiooni.
Avalikud akupassid
Igal akupassil on püsiv aadress (GS1 Digital Link /01/{GTIN}/21/{serial} või /id/{operator}/{model}/{serial}). Päisega Accept: application/json või parameetriga ?format=json tagastab see uusima versiooni JSON-i teie juurdepääsutasemel; ?version=N kindla versiooni; /versions loendi.
Iga versioon on allkirjastatud: X-Passport-SHA256 sisaldab kogu versiooni RFC 8785 kanoonilise JSON-i SHA-256, X-Passport-Signature selle Ed25519 allkirja üle selle kuueteistkümnendsüsteemi sõne ja X-Passport-Key-Id võtit, millega allkirjastati. Avalikud võtmed ja skeem on loetletud jaotises Masinloetavad kirjeldused.
Veebikonksud
Pideva päringu asemel lisage lõpp-punkt jaotises Company → Webhooks. Sündmused – passport.published, publish_job.finished, item.lifecycle_recorded, access_request.created, passport.transferred, label_template.issued, dossier.ready, import_batch.assigned, import_batch.confirmed, import_batch.rejected – saadetakse POST-iga JSON-ina päistega X-Webhook-Id, X-Webhook-Timestamp ja X-Webhook-Signature = v1= + timestamp.body kuueteistkümnendsüsteemis HMAC-SHA256 teie saladusega. Vastake 2xx 10 sekundi jooksul; ebaõnnestunud edastusi korratakse 24 tundi.
Masinloetavad kirjeldused
- Avalikud allkirjastamisvõtmed (JWKS)/.well-known/batterycompliance-signing-key.json
- Akupassi JSON-skeem/schema/battery-passport/2.0.0
- OpenAPI 3.1 – akupasside haldamise API/openapi.json
- OpenAPI 3.1 – DPP API/openapi-dpp.json
Hankige API võti
Registreerige oma ettevõte ja looge seejärel võti jaotises Company → API keys. Võtmeid näidatakse üks kord ja neid hoitakse ainult räsina.