Zum Inhalt springen
BatteryPass Docs
Portal
Erste SchritteAnleitungenRezepteIntegrationenAPI-ReferenzÄnderungen
Pässe

A PDF of a version with every tier, restricted rows tagged, the signature and the QR code

Scope: readSiehe auch:Authentifizierung ·Fehler ·Paginierung ·Ratenlimits
GET
/batteries/{batteryId}/passport/versions/{versionNo}/pdf

Any member.

Autorisierung

apiKey
headerAutorisierungBearer <Token>

Organisation API key sent as Authorization: Bearer bp_live_… (ADR-017). Accepted only by the operations that list this scheme, with the scope in their x-api-key-scope.

Pfad-Parameter

batteryId*string
Formatuuid
versionNo*integer
Bereich1 <= value

Query-Parameter

lang?string

Preferred language for emails and the portal.

Wert in"de""en"

Antwort-Body

The PDF.

response?unknownapplication/pdf
Beispielanfrage
curl -X GET 'https://example.com/api/v1/batteries/497f6eca-6276-4993-bfeb-53cbbbba6f08/passport/versions/1/pdf'
Beispielantwort
null

The BatteryPass v2.0 export of a version (all tiers) GET

Any member. The stored export, including restricted data; sent as an attachment. Its schema report is in `getPassportVersion` (advisory, ADR-012).

The QR code of the unit's GS1 Digital Link GET

Any member. Rendered on demand from `gs1_digital_link` (error correction M, quiet zone of four modules). Only once the identifiers are locked (`409 conflict` before).