مرجع الربط البرمجي لفحص اللوحات
مرجع الربط البرمجي لفحص اللوحات يعرض كل نقطة ربط مع معاملاتها وأكواد الرد وحقولها. لدى زيفرا تُبنى هذه الصفحة مباشرة من الوصف المقروء آلياً للربط البرمجي، لذلك لا تختلف أبداً عن الخدمة العاملة.
فحص اللوحات · إضافة فحص اللوحات · تغطية فحص اللوحات
العنوان الأساسي والمفتاح
| البند | القيمة |
|---|---|
| العنوان الأساسي | https://app.zevra24.de/api/kc/v1 |
| المفتاح في الترويسة | X-WKZ-Key · Authorization: Bearer |
| الحد لكل مفتاح | 120 طلباً في الدقيقة |
| مفتاح التجربة | يبدأ بـ wkz_sbx_: حالات ثابتة، دون جهة رسمية، ودون محاسبة |
السعر كما في الوصف: 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.
نقاط الربط
«بمفتاح» تعني: الترويسة X-WKZ-Key أو Authorization: Bearer. كل رد على نداء بمفتاح يحمل ترويسات الحد.
- GETVerfügbarkeit einer Kombination prüfen (بمفتاح)
- POSTVerfügbarkeit aus dem domaingebundenen Widget prüfen (دون مفتاح)
- POSTÖffentliche Zevra-Testabfrage, 10 Versuche pro Besucher und Tag (دون مفتاح)
- POSTBis zu 50 Kombinationen in einem Aufruf prüfen (بمفتاح)
- POSTReservierung anlegen (nur mit aktivem Abonnement oder Sandbox-Schlüssel) (بمفتاح)
- GETStatus einer Reservierung (بمفتاح)
- GETVerbrauch und Kosten des laufenden Zeitraums (بمفتاح)
- GETZulassungsstellen und Zustand, optional nach Kürzel gefiltert (ohne Schlüssel) (دون مفتاح)
- GETFeste Szenarien der Sandbox (ohne Schlüssel) (دون مفتاح)
- GETDiese Beschreibung (دون مفتاح)
- GETDiese Beschreibung als Postman-Sammlung (ohne Schlüssel) (دون مفتاح)
GETVerfügbarkeit einer Kombination prüfen
GET https://app.zevra24.de/api/kc/v1/search
بمفتاح
المعاملات
prefixquery · إلزامي- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersquery · إلزامي- 1 bis 2 Buchstaben
numbersquery · إلزامي- 1 bis 4 Ziffern, ohne führende Null
plzquery- Postleitzahl, wenn das Kürzel zu mehreren Zulassungsstellen gehört (ambiguous_prefix) · 5 خانات أرقام بالضبط
office_idquery- Kennung der Zulassungsstelle aus der Antwort ambiguous_prefix
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
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
دون مفتاح
المعاملات
Originheader · إلزامي- –
محتوى الطلب
application/x-www-form-urlencoded ·
site_keystring· إلزامي- يبدأ بـ
wkz_site_ codestring· إلزامي- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersstring· إلزامي- 1 bis 2 Buchstaben
numbersstring· إلزامي- 1 bis 4 Ziffern, ohne führende Null
plzstring- 5 خانات أرقام بالضبط
office_idstring- 40 أحرف كحد أقصى
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
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
دون مفتاح
المعاملات
Originheader · إلزامي- –
محتوى الطلب
application/x-www-form-urlencoded ·
codestring· إلزامي- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersstring· إلزامي- 1 bis 2 Buchstaben
numbersstring· إلزامي- 1 bis 4 Ziffern, ohne führende Null
plzstring- 5 خانات أرقام بالضبط
office_idstring- 40 أحرف كحد أقصى
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
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
بمفتاح
محتوى الطلب
application/json ·
itemsarray <Plate> · إلزامي- عنصر واحد على الأقل · 50 عنصر كحد أقصى
الردود
POSTReservierung anlegen (nur mit aktivem Abonnement oder Sandbox-Schlüssel)
POST https://app.zevra24.de/api/kc/v1/reservations
بمفتاح
المعاملات
Idempotency-Keyheader · إلزامي- 8 أحرف على الأقل · 80 أحرف كحد أقصى
محتوى الطلب
application/json · ReservationRequest
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
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}بمفتاح
المعاملات
ridpath · إلزامي- –
الردود
GETVerbrauch und Kosten des laufenden Zeitraums
GET https://app.zevra24.de/api/kc/v1/usage
بمفتاح
الردود
GETZulassungsstellen und Zustand, optional nach Kürzel gefiltert (ohne Schlüssel)
GET https://app.zevra24.de/api/kc/v1/offices
دون مفتاح
المعاملات
codequery- –
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
200 | OK | Offices |
GETFeste Szenarien der Sandbox (ohne Schlüssel)
GET https://app.zevra24.de/api/kc/v1/sandbox/scenarios
دون مفتاح
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
200 | OK | – |
GETDiese Beschreibung
GET https://app.zevra24.de/api/kc/v1/openapi.json
دون مفتاح
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
200 | OK | – |
GETDiese Beschreibung als Postman-Sammlung (ohne Schlüssel)
GET https://app.zevra24.de/api/kc/v1/postman.json
دون مفتاح
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
200 | OK | – |
الإشعار الآلي (Webhook)
reservation.updated
Statuswechsel einer Reservierung, signiert mit HMAC-SHA256 (X-Zevra-Signature über »Zeitstempel.Inhalt«)
المعاملات
X-Zevra-Eventheader · إلزامي- –
X-Zevra-Timestampheader · إلزامي- –
X-Zevra-Signatureheader · إلزامي- –
محتوى الطلب
application/json ·
idstring- –
typestring- القيم:
reservation.updated createdstring- –
dataReservation- –
الردود
| الكود | المعنى | نموذج البيانات |
|---|---|---|
200 | Jede 2xx-Antwort gilt als zugestellt; sonst Wiederholung nach 1, 5, 30, 120, 720 Minuten | – |
ترويسات الحد
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
نماذج البيانات
أوصاف الحقول منقولة كما هي من ملف OpenAPI وهي بالألمانية.
Error
errorstring· إلزامي- القيم:
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· إلزامي- –
message_enstring- Dieselbe Meldung auf Englisch
quotaobject- Nur bei quota_exhausted: Stand des Kontingents
Plate
prefixstring· إلزامي- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersstring· إلزامي- 1 bis 2 Buchstaben
numbersstring· إلزامي- 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 القيم:
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) القيم:
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· إلزامي- –
vornamestring- –
geburtsdatumstring- –
strassestring- –
plzstring· إلزامي- –
ortstring· إلزامي- –
Reservation
idstring- –
statusstring- القيم:
queued·processing·reserved·failed environmentstring- القيم:
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· إلزامي- Unterscheidungszeichen, 1 bis 3 Buchstaben
lettersstring· إلزامي- 1 bis 2 Buchstaben
numbersstring· إلزامي- 1 bis 4 Ziffern, ohne führende Null
halterHolder · إلزامي- –
customerReferencestring- 80 أحرف كحد أقصى
Usage
environmentstring- –
statusstring- –
checksinteger- –
limitinteger- –
reservationsinteger- –
usageCentsinteger- –
authorityFeesAdvancedCentsinteger- –
periodEndstring | null- –
Offices
countinteger- –
officesarray <object>- –
ملفات للتحميل
أسئلة عن مرجع الربط البرمجي
هل هذا المرجع محدَّث دائماً؟
كيف أجرّب دون تكلفة؟
ماذا يحدث فوق 120 طلباً في الدقيقة؟
أي رد يُحتسب؟
المزيد عن فحص اللوحات
فحص اللوحات · إضافة فحص اللوحات · تغطية فحص اللوحات · فحص اللوحات لمواقع اللوحات · فحص اللوحات لمكاتب خدمات التسجيل · حالة فحص اللوحات
مكاتب تسجيل بفحص مباشر، على سبيل المثال: Berlin · Hamburg · Frankfurt am Main · Stuttgart · Kreis Recklinghausen · Düsseldorf · Dortmund