Plaka sorgusu API referansı
Plaka sorgusu API referansı her uç noktayı parametreleri, yanıt kodları ve alanlarıyla listeler. Zevra'da bu sayfa doğrudan API'nin makine tarafından okunabilir tanımından üretilir, bu yüzden çalışan API'den asla sapmaz.
Plaka sorgusu · Plaka sorgusunu entegre edin · Plaka sorgusu kapsamı
Temel adres ve anahtar
| Konu | Değer |
|---|---|
| Temel adres | https://app.zevra24.de/api/kc/v1 |
| Başlıktaki anahtar | X-WKZ-Key · Authorization: Bearer |
| Anahtar başına sınır | Dakikada 120 istek |
| Sandbox anahtarı | wkz_sbx_ ile başlar: sabit senaryolar, kurum yok, ücret yok |
Tanımdaki fiyat: 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.
Uç noktalar
Anahtarlı demek: X-WKZ-Key başlığı veya Authorization: Bearer. Anahtarlı her yanıt sınır başlıklarını taşır.
- GETVerfügbarkeit einer Kombination prüfen (anahtarlı)
- POSTVerfügbarkeit aus dem domaingebundenen Widget prüfen (anahtarsız)
- POSTÖffentliche Zevra-Testabfrage, 10 Versuche pro Besucher und Tag (anahtarsız)
- POSTBis zu 50 Kombinationen in einem Aufruf prüfen (anahtarlı)
- POSTReservierung anlegen (nur mit aktivem Abonnement oder Sandbox-Schlüssel) (anahtarlı)
- GETStatus einer Reservierung (anahtarlı)
- GETVerbrauch und Kosten des laufenden Zeitraums (anahtarlı)
- GETZulassungsstellen und Zustand, optional nach Kürzel gefiltert (ohne Schlüssel) (anahtarsız)
- GETFeste Szenarien der Sandbox (ohne Schlüssel) (anahtarsız)
- GETDiese Beschreibung (anahtarsız)
- GETDiese Beschreibung als Postman-Sammlung (ohne Schlüssel) (anahtarsız)
GETVerfügbarkeit einer Kombination prüfen
GET https://app.zevra24.de/api/kc/v1/search
anahtarlı
Parametreler
prefixquery · zorunlu- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersquery · zorunlu- 1 bis 2 Buchstaben
numbersquery · zorunlu- 1 bis 4 Ziffern, ohne führende Null
plzquery- Postleitzahl, wenn das Kürzel zu mehreren Zulassungsstellen gehört (ambiguous_prefix) · tam 5 hane, yalnızca rakam
office_idquery- Kennung der Zulassungsstelle aus der Antwort ambiguous_prefix
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | OK | SearchResult |
401 | Schlüssel fehlt oder ist ungültig | Error |
403 | Zugang beendet (revoked) | Error |
429 | Monatslimit erreicht oder zu viele Anfragen | Error |
503 | Dienst vorübergehend nicht verfügbar | Error |
POSTVerfügbarkeit aus dem domaingebundenen Widget prüfen
POST https://app.zevra24.de/api/kc/v1/widget/search
anahtarsız
Parametreler
Originheader · zorunlu- –
İstek gövdesi
application/x-www-form-urlencoded ·
site_keystring· zorunlu- şununla başlar:
wkz_site_ codestring· zorunlu- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersstring· zorunlu- 1 bis 2 Buchstaben
numbersstring· zorunlu- 1 bis 4 Ziffern, ohne führende Null
plzstring- tam 5 hane, yalnızca rakam
office_idstring- en fazla 40 karakter
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | OK | SearchResult |
400 | Ungültige Anfrage | Error |
401 | Site-Schlüssel oder Domain ungültig | Error |
429 | Limit erreicht | Error |
503 | Dienst nicht verfügbar | Error |
POSTÖffentliche Zevra-Testabfrage, 10 Versuche pro Besucher und Tag
POST https://app.zevra24.de/api/kc/v1/public/search
anahtarsız
Parametreler
Originheader · zorunlu- –
İstek gövdesi
application/x-www-form-urlencoded ·
codestring· zorunlu- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersstring· zorunlu- 1 bis 2 Buchstaben
numbersstring· zorunlu- 1 bis 4 Ziffern, ohne führende Null
plzstring- tam 5 hane, yalnızca rakam
office_idstring- en fazla 40 karakter
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | OK | SearchResult |
400 | Ungültige Anfrage | Error |
401 | Anfragequelle ungültig | Error |
429 | Tageslimit erreicht | Error |
503 | Dienst nicht verfügbar | Error |
POSTBis zu 50 Kombinationen in einem Aufruf prüfen
POST https://app.zevra24.de/api/kc/v1/search/batch
anahtarlı
İstek gövdesi
application/json ·
itemsarray <Plate> · zorunlu- en az 1 öğe · en fazla 50 öğe
Yanıtlar
POSTReservierung anlegen (nur mit aktivem Abonnement oder Sandbox-Schlüssel)
POST https://app.zevra24.de/api/kc/v1/reservations
anahtarlı
Parametreler
Idempotency-Keyheader · zorunlu- en az 8 karakter · en fazla 80 karakter
İstek gövdesi
application/json · ReservationRequest
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | Bereits angelegt (gleicher Idempotency-Key) | Reservation |
202 | Angenommen | Reservation |
400 | Ungültige Anfrage | Error |
401 | Schlüssel fehlt oder ist ungültig | Error |
403 | Abonnement erforderlich | Error |
409 | Idempotency-Key mit anderem Inhalt verwendet | Error |
429 | Monatslimit erreicht oder zu viele Anfragen | Error |
503 | Dienst vorübergehend nicht verfügbar | Error |
GETStatus einer Reservierung
GET https://app.zevra24.de/api/kc/v1/reservations/{rid}anahtarlı
Parametreler
ridpath · zorunlu- –
Yanıtlar
GETVerbrauch und Kosten des laufenden Zeitraums
GET https://app.zevra24.de/api/kc/v1/usage
anahtarlı
Yanıtlar
GETZulassungsstellen und Zustand, optional nach Kürzel gefiltert (ohne Schlüssel)
GET https://app.zevra24.de/api/kc/v1/offices
anahtarsız
Parametreler
codequery- –
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | OK | Offices |
GETFeste Szenarien der Sandbox (ohne Schlüssel)
GET https://app.zevra24.de/api/kc/v1/sandbox/scenarios
anahtarsız
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | OK | – |
GETDiese Beschreibung
GET https://app.zevra24.de/api/kc/v1/openapi.json
anahtarsız
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | OK | – |
GETDiese Beschreibung als Postman-Sammlung (ohne Schlüssel)
GET https://app.zevra24.de/api/kc/v1/postman.json
anahtarsız
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | OK | – |
Webhook
reservation.updated
Statuswechsel einer Reservierung, signiert mit HMAC-SHA256 (X-Zevra-Signature über »Zeitstempel.Inhalt«)
Parametreler
X-Zevra-Eventheader · zorunlu- –
X-Zevra-Timestampheader · zorunlu- –
X-Zevra-Signatureheader · zorunlu- –
İstek gövdesi
application/json ·
idstring- –
typestring- Değerler:
reservation.updated createdstring- –
dataReservation- –
Yanıtlar
| Kod | Anlamı | Veri modeli |
|---|---|---|
200 | Jede 2xx-Antwort gilt als zugestellt; sonst Wiederholung nach 1, 5, 30, 120, 720 Minuten | – |
Sınır başlıkları
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
Veri modelleri
Alan açıklamaları OpenAPI dosyasından değiştirilmeden alınmıştır ve Almancadır.
Error
errorstring· zorunlu- Değerler:
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· zorunlu- –
message_enstring- Dieselbe Meldung auf Englisch
quotaobject- Nur bei quota_exhausted: Stand des Kontingents
Plate
prefixstring· zorunlu- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersstring· zorunlu- 1 bis 2 Buchstaben
numbersstring· zorunlu- 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 Değerler:
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) Değerler:
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· zorunlu- –
vornamestring- –
geburtsdatumstring- –
strassestring- –
plzstring· zorunlu- –
ortstring· zorunlu- –
Reservation
idstring- –
statusstring- Değerler:
queued·processing·reserved·failed environmentstring- Değerler:
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· zorunlu- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersstring· zorunlu- 1 bis 2 Buchstaben
numbersstring· zorunlu- 1 bis 4 Ziffern, ohne führende Null
halterHolder · zorunlu- –
customerReferencestring- en fazla 80 karakter
Usage
environmentstring- –
statusstring- –
checksinteger- –
limitinteger- –
reservationsinteger- –
usageCentsinteger- –
authorityFeesAdvancedCentsinteger- –
periodEndstring | null- –
Offices
countinteger- –
officesarray <object>- –
İndirilebilir dosyalar
API referansı hakkında sorular
Bu referans her zaman güncel mi?
Ücretsiz nasıl test ederim?
Dakikada 120 istekten fazlasında ne olur?
Hangi yanıt ücretlendirilir?
Plaka sorgusu hakkında daha fazlası
Plaka sorgusu · Plaka sorgusunu entegre edin · Plaka sorgusu kapsamı · Plaka mağazaları için sorgu · Tescil hizmetleri için plaka sorgusu · Plaka sorgusu durumu
Canlı sorgulu tescil daireleri, örneğin: Berlin · Hamburg · Frankfurt am Main · Stuttgart · Kreis Recklinghausen · Düsseldorf · Dortmund