Forbróirí
Dhá API
API bainistithe pasanna
/openapi.jsonDon chuideachta ar leis na pasanna: liostáil samhlacha agus míreanna (le cúrsóir, le updatedSince don sioncrónú), cruthaigh míreanna, raonta agus cóipeanna de shamhlacha, nuashonraigh sonraí míre, foilsigh (mír amháin nó sa chúlra) agus faigh cóid QR. Fíordheimhnithe le heochair API.
Tagairt: API bainistithe pasannaAPI DPP (EN 18222)
/openapi-dpp.jsonAPI Life Cycle agus Fine Granular a leanann EN 18222: léigh pasanna ar do leibhéal rochtana, cuardaigh IDanna pasanna de réir ID táirge, taifead imeachtaí (deisiú, staid sláinte, stádas) le comhartha rochtana OAuth 2.0. Is féidir sonraí poiblí a léamh gan chomhartha.
Tagairt: API DPP (EN 18222)
Léigh pas
Freagraíonn gach seoladh pas le JSON nuair a iarrann tú é – gan eochair ag teastáil do shonraí poiblí. Iompraíonn na ceanntásca an leagan, a SHA-256 agus an síniú Ed25519, mar sin is féidir leat an méid a léann tú a sheiceáil i gcoinne ár n-eochracha poiblí.
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", … }, … }Conas a oibríonn na APInna
Fíordheimhniú
Cruthaíonn úinéir na cuideachta eochracha API in Company → API keys agus taispeántar uair amháin iad. Seol iad mar Authorization: Bearer bcp_live_…. Scóipeanna: items:read, items:write (léann sé freisin), items:publish, qr:read.
Cruthaíonn úinéir na cuideachta cliaint OAuth 2.0 (client credentials) dá chomhpháirtithe, nó cruthaíonn an t-ardán iad d’údaráis agus do thríú páirtithe formheasta. Faigh comhartha le POST /oauth/token (grant_type=client_credentials); tá sé bailí ar feadh 15 nóiméad. Scóipeanna: dpp:read, dpp:search, dpp:write.
Teorainneacha agus earráidí
60 iarratas in aghaidh na nóiméide in aghaidh eochrach API (ceanntásca X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) agus 120 in aghaidh na nóiméide in aghaidh cliaint OAuth nó, gan chomhartha, in aghaidh seolta. Os cionn na teorann: HTTP 429 le Retry-After.
Freagraíonn an API bainistithe pasanna earráidí le réad error de code, message agus details; freagraíonn an API DPP statusCode, payload agus result le cóid stádais EN 18222.
Glacann nuashonruithe API DPP le ceanntásc Idempotency-Key: tugann an eochair chéanna leis an iarratas céanna laistigh de 24 uair an chloig an chéad fhreagra ar ais agus ní chruthaíonn sé dara leagan.
Pasanna poiblí
Tá seoladh buan ag gach pas (GS1 Digital Link /01/{GTIN}/21/{serial} nó /id/{operator}/{model}/{serial}). Le Accept: application/json nó ?format=json tugann sé JSON an leagain is déanaí ar ais do do leibhéal rochtana; ?version=N leagan áirithe; /versions an liosta.
Síníotar gach leagan: iompraíonn X-Passport-SHA256 SHA-256 de JSON canónach RFC 8785 an leagain iomláin, X-Passport-Signature a shíniú Ed25519 ar an teaghrán heicsidheachúlach sin agus X-Passport-Key-Id an eochair a shínigh é. Tá na heochracha poiblí agus an scéimre liostaithe faoi Cur síos inléite ag meaisín.
Webhooks
In ionad pobalscrúdú, cuir críochphointe leis in Company → Webhooks. Seoltar imeachtaí – 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 – mar JSON POST leis na ceanntásca X-Webhook-Id, X-Webhook-Timestamp agus X-Webhook-Signature = v1= + HMAC-SHA256 heicsidheachúlach de timestamp.body le do rún. Freagair 2xx laistigh de 10 soicind; athdhéantar seachadtaí a theip ar feadh 24 uair an chloig.
Cur síos inléite ag meaisín
- Eochracha sínithe poiblí (JWKS)/.well-known/batterycompliance-signing-key.json
- Scéimre JSON an phas/schema/battery-passport/2.0.0
- OpenAPI 3.1 – API bainistithe pasanna/openapi.json
- OpenAPI 3.1 – API DPP/openapi-dpp.json
Faigh eochair API
Cláraigh do chuideachta, ansin cruthaigh eochair in Company → API keys. Taispeántar eochracha uair amháin agus ní stóráiltear ach mar haise iad.