Kennzeichen-Check API-Referenz

Kennzeichen-Check · Kennzeichen-Check einbinden · Kennzeichen-Check Abdeckung

Basisadresse und Schlüssel

Preis laut Beschreibung: Wunschkennzeichen live prüfen und reservieren. Grundgebühr 50,00 € im Monat, 0,05 € je berechneter Prüfung, 2,00 € je erfolgreicher Reservierung (netto, zuzüglich Behördengebühren). Limit: 120 Anfragen pro Minute je Schlüssel. Schlüssel mit wkz_sbx_ sind Sandbox-Schlüssel: feste Szenarien, keine Behörde, keine Berechnung.

Endpunkte

Mit Schlüssel heißt: Header X-WKZ-Key oder Authorization: Bearer. Jede Antwort mit Schlüssel trägt die Limit-Header.

• GETVerfügbarkeit einer Kombination prüfen (mit Schlüssel)
• POSTVerfügbarkeit aus dem domaingebundenen Widget prüfen (ohne Schlüssel)
• POSTÖffentliche Zevra-Testabfrage, 10 Versuche pro Besucher und Tag (ohne Schlüssel)
• POSTBis zu 50 Kombinationen in einem Aufruf prüfen (mit Schlüssel)
• POSTReservierung anlegen (nur mit aktivem Abonnement oder Sandbox-Schlüssel) (mit Schlüssel)
• GETStatus einer Reservierung (mit Schlüssel)
• GETVerbrauch und Kosten des laufenden Zeitraums (mit Schlüssel)
• GETZulassungsstellen und Zustand, optional nach Kürzel gefiltert (ohne Schlüssel) (ohne Schlüssel)
• GETFeste Szenarien der Sandbox (ohne Schlüssel) (ohne Schlüssel)
• GETDiese Beschreibung (ohne Schlüssel)
• GETDiese Beschreibung als Postman-Sammlung (ohne Schlüssel) (ohne Schlüssel)

GET https://app.zevra24.de/api/kc/v1/search

POST https://app.zevra24.de/api/kc/v1/widget/search

POST https://app.zevra24.de/api/kc/v1/public/search

POST https://app.zevra24.de/api/kc/v1/search/batch

POST https://app.zevra24.de/api/kc/v1/reservations

GET https://app.zevra24.de/api/kc/v1/reservations/{rid}

GET https://app.zevra24.de/api/kc/v1/usage

GET https://app.zevra24.de/api/kc/v1/offices

GET https://app.zevra24.de/api/kc/v1/sandbox/scenarios

GET https://app.zevra24.de/api/kc/v1/openapi.json

GET https://app.zevra24.de/api/kc/v1/postman.json

Webhook

Limit-Header

X-RateLimit-Limitinteger

Anfragen pro Minute je Schlüssel

X-RateLimit-Remaininginteger

Verbleibende Anfragen in der laufenden Minute

X-RateLimit-Resetinteger

Sekunden bis zur nächsten Minute

Retry-Afterinteger

Nur bei zu vielen Anfragen pro Minute: Sekunden bis zum nächsten Versuch

Datenmodelle

Beschreibungen der Felder stammen unverändert aus der OpenAPI-Datei.

Error

errorstring · Pflichtfeld

Werte: backend · bad_request · batch_size · holder · idem_conflict · idem_key · letters · no_backend · not_found · numbers · prefix · quota_exhausted · rate_limited · revoked · subscription_required · unauthorized

messagestring · Pflichtfeld

–

message_enstring

Dieselbe Meldung auf Englisch

quotaobject

Nur bei quota_exhausted: Stand des Kontingents

Plate

prefixstring · Pflichtfeld

Unterscheidungszeichen, 1 bis 3 Buchstaben

lettersstring · Pflichtfeld

1 bis 2 Buchstaben

numbersstring · Pflichtfeld

1 bis 4 Ziffern, ohne führende Null

SearchResult

platestring | null

–

availableboolean | null

true = frei · false = vergeben · null = keine Aussage (nie als vergeben anzeigen)

reasonstring

Ohne Aussage (available = null): office_not_queryable/gate = Stelle nicht online prüfbar · check_failed/captcha_expired = Stelle antwortet gerade nicht, später erneut · unknown_prefix/unknown_office = Kürzel unbekannt · ambiguous_prefix = mehrere Stellen, plz oder office_id angeben. quota_exhausted · revoked · rate_limited · no_backend nur in /search/batch: ab diesem Eintrag wurde nicht mehr geprüft Werte: checked · checked_via_twin · checked_via_warm_session · checked_via_captcha · check_failed · captcha_expired · gate · office_not_queryable · ambiguous_prefix · unknown_prefix · unknown_office · invalid · quota_exhausted · revoked · rate_limited · no_backend

sandboxboolean

–

known_officeboolean

Das Kürzel gehört zu einer bekannten Zulassungsstelle

checkableboolean

Die Zulassungsstelle ist live abfragbar

latency_msinteger

Antwortzeit der Behörde in Millisekunden

plate_invalidstring

Gesetzt, wenn die Kombination formal unzulässig ist (keine Prüfung gezählt) Werte: prefix · letters · numbers · office

remaining_todayinteger

Nur /public/search: verbleibende Testabfragen heute

suggestionsarray <object>

Nur /public/search bei vergebenem Kennzeichen: freie Alternativen

suggestions_limitedboolean

Nur /public/search: die Behörde nannte weniger Alternativen als angefragt

suggestions_unavailableboolean

Nur /public/search: Alternativen konnten gerade nicht abgefragt werden

Holder

namestring · Pflichtfeld

–

vornamestring

–

geburtsdatumstring

–

strassestring

–

plzstring · Pflichtfeld

–

ortstring · Pflichtfeld

–

Reservation

idstring

–

statusstring

Werte: queued · processing · reserved · failed

environmentstring

Werte: live · sandbox

platestring

–

customerReferencestring | null

–

reasonstring | null

–

reservationCodestring | null

Code der Behörde für die Zulassung, nur bei status=reserved

authorityFeeAdvancedCentsinteger

Von Zevra verauslagte Behördengebühr in Cent (durchlaufender Posten)

createdAtstring

–

updatedAtstring

–

BatchResult

countinteger

–

resultsarray <SearchResult>

–

ReservationRequest

prefixstring · Pflichtfeld

Unterscheidungszeichen, 1 bis 3 Buchstaben

lettersstring · Pflichtfeld

1 bis 2 Buchstaben

numbersstring · Pflichtfeld

1 bis 4 Ziffern, ohne führende Null

halterHolder · Pflichtfeld

–

customerReferencestring

höchstens 80 Zeichen

Usage

environmentstring

–

statusstring

–

checksinteger

–

limitinteger

–

reservationsinteger

–

usageCentsinteger

–

authorityFeesAdvancedCentsinteger

–

periodEndstring | null

–

Offices

countinteger

–

officesarray <object>

–

Dateien zum Herunterladen

• Maschinenlesbare Beschreibung der Schnittstelle (OpenAPI 3.1)
• Postman-Sammlung herunterladen (ohne Schlüssel, Ihren tragen Sie selbst ein)