Dokumentation

Anwendungsfall · Software

Kfz-Zulassung API für Plattformen und SaaS

Backend-Integration für Portale und Fachsoftware mit getrennten Mandanten, Schlüsseln und Umgebungen.

Backend und API-Grenze

Web- und App-Clients sprechen mit dem eigenen Backend. Nur das Backend ruft die Fahrzeugzulassung API auf. API-Schlüssel dürfen nicht an Clients ausgeliefert werden.

Verwenden Sie ausschließlich die dokumentierten Routen unter /api/v1/. Dashboard-Sitzungen und interne Endpunkte gehören nicht zum öffentlichen API-Vertrag.

Mandanten und Konten

  • Ordnen Sie jeden API-Schlüssel eindeutig einem Konto und einer Umgebung zu.
  • Speichern Sie die Zuordnung serverseitig und wählen Sie den Schlüssel nicht anhand frei übermittelter Browserdaten aus.
  • Verwenden Sie getrennte Schlüssel für Entwicklung, Abnahme und Produktion.
  • Protokollieren Sie Request-ID, Antrags-ID und eigene Referenz – niemals Schlüssel, Signaturlinks oder vollständige Dokumente.

Statusanzeige

API-SignalGeeignete Darstellung
next_action.type: sign_applicationSignatur fortsetzen
preparing_signatureSignaturlink wird vorbereitet; später erneut abrufen
awaiting_signatureSignatur steht aus
processingAntrag wird bearbeitet
manual_reviewFall zur manuellen Prüfung markieren
succeededErgebnis bereitstellen und verfügbare Dokumente beziehungsweise Gebühren laden
failedAntrag fehlgeschlagen; nicht als API-Ausfall behandeln

Integration deterministisch abnehmen

  1. 01

    Testantrag erzeugen

    Legen Sie eine Ressource mit demselben Requestformat wie in Produktion unter /api/v1/test/applications an.

  2. 02

    Signaturübergabe prüfen

    Testen Sie den Wechsel aus Ihrer Oberfläche in den Signaturprozess und zurück.

  3. 03

    Teststatus setzen

    Nutzen Sie den Testereignis-Endpunkt für Bearbeitung, Abschluss und Fehlschlag.

  4. 04

    Ergebnisse verarbeiten

    Validieren Sie Statusmapping, Binärdownloads, Gebührenbeträge und die Behandlung leerer Ergebnislisten.

Zum Öffnen eines Treffers Enter drücken.