Support
Wie Sie Hilfe zu einer Integration bekommen, was in eine Anfrage gehört und wo der Stand der Funktionen dokumentiert ist.
Wen Sie ansprechen
| Frage | Ansprechpartner |
|---|---|
| API-Schlüssel, Scopes, Einstellungen der Organisation wie die Regel für die Neuveröffentlichung | Ein Inhaber Ihrer Organisation, im Portal |
| Daten in einem Pass, Prüfung, Veröffentlichung | Die für die Daten verantwortlichen Mitglieder Ihrer Organisation |
| Unerklärliche Fehler, Ausfälle, vermutete Sicherheitsprobleme | Ihr Ansprechpartner für BatteryPass oder der Betreiber Ihrer BatteryPass-Installation |
Supportwege und Reaktionszeiten vereinbaren Sie mit dem Betreiber Ihrer Installation; diese Dokumentation legt sie nicht fest.
Vorher prüfen
code,detailunderrors[]des Problems nennen meist die Ursache; Fehler erklärt jeden Code, und Fehler behandeln zeigt, wie Sie darauf reagieren.429 rate_limited: Warten Sie die Sekunden ausRetry-Afterab (Ratenlimits).403 forbiddenmit einem Schlüssel: Dem Schlüssel fehlt der Scope der Operation, oder die Operation verlangt mehr als die Rechte eines Betrachters (Authentifizierung).
Die Request-Id angeben
Jede Antwort, ob erfolgreich oder nicht, trägt den Header X-Request-Id. Fehlerantworten wiederholen ihn als
request_id im Problem. Mit dieser Id findet der Betreiber Ihre Anfrage in den Logs. Eine X-Request-Id, die Sie
selbst senden, ignoriert BatteryPass und vergibt immer eine eigene; protokollieren Sie also die aus der Antwort.
curl -s -D - -o /dev/null "$BATTERYPASS_URL/api/v1/battery-models?limit=1" \
-H "Authorization: Bearer $BATTERYPASS_API_KEY" | grep -i '^x-request-id'Was in die Anfrage gehört
Den Aufruf benennen
Die request_id, die Uhrzeit in UTC, die Operation (etwa updateCondition, oder Methode und Pfad) und den
HTTP-Status mit code, detail und errors[] des Problems.
Schlüssel und Daten benennen
Das Präfix des Schlüssels (seine ersten 12 Zeichen, wie das Portal sie zeigt) und die beteiligten Ids: Batterie-Id, UUID des Passes, Versionsnummer.
Den Fall beschreiben
Was Sie erwartet haben, was passiert ist und ob es jedes Mal oder nur manchmal auftritt.
Senden Sie nie den vollständigen API-Schlüssel, und lassen Sie personenbezogene Daten sowie Exporte mit eingeschränkten Stufen weg (BatteryPass JSON und PDF einer Passversion). Request-Id und Ids genügen, um die Anfrage zu finden.
Stand der Funktionen
- Das Changelog nennt, was sich an der API und an dieser Dokumentation geändert hat, auch als RSS-Feed.
- Der veröffentlichte Vertrag nennt seine Version in
info.version; Sie laden ihn als JSON oder YAML herunter. getRegistryInfoundgetRegistryStatusmelden das verwendete Feldregister und wie viele Pässe nach einer Registeränderung aktualisiert werden müssen.getRegistrySubmissionStatusmeldet den Stand eines Passes im EU-Register; er istnot_available, solange das EU-Register Wirtschaftsakteuren keine Schnittstelle bietet.