ZEVRA › مرجع الربط البرمجي · آخر تحديث:
OpenAPI 3.1 · 11 نقطة ربط

مرجع الربط البرمجي لفحص اللوحات

مرجع الربط البرمجي لفحص اللوحات يعرض كل نقطة ربط مع معاملاتها وأكواد الرد وحقولها. لدى زيفرا تُبنى هذه الصفحة مباشرة من الوصف المقروء آلياً للربط البرمجي، لذلك لا تختلف أبداً عن الخدمة العاملة.

فحص اللوحات · إضافة فحص اللوحات · تغطية فحص اللوحات

العنوان الأساسي والمفتاح

البندالقيمة
العنوان الأساسي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. كل رد على نداء بمفتاح يحمل ترويسات الحد.

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 أحرف كحد أقصى

الردود

الكودالمعنىنموذج البيانات
200OKSearchResult
400Ungültige AnfrageError
401Site-Schlüssel oder Domain ungültigError
429Limit erreichtError
503Dienst nicht verfügbarError

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 أحرف كحد أقصى

الردود

الكودالمعنىنموذج البيانات
200OKSearchResult
400Ungültige AnfrageError
401Anfragequelle ungültigError
429Tageslimit erreichtError
503Dienst nicht verfügbarError

POSTBis zu 50 Kombinationen in einem Aufruf prüfen

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

بمفتاح

محتوى الطلب

application/json ·

itemsarray <Plate> · إلزامي
عنصر واحد على الأقل · 50 عنصر كحد أقصى

الردود

الكودالمعنىنموذج البيانات
200OKBatchResult
400Ungültige AnfrageError
401Schlüssel fehlt oder ist ungültigError
403Zugang beendet (revoked)Error
429Monatslimit erreicht oder zu viele AnfragenError
503Dienst vorübergehend nicht verfügbarError

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

الردود

الكودالمعنىنموذج البيانات
200Bereits angelegt (gleicher Idempotency-Key)Reservation
202AngenommenReservation
400Ungültige AnfrageError
401Schlüssel fehlt oder ist ungültigError
403Abonnement erforderlichError
409Idempotency-Key mit anderem Inhalt verwendetError
429Monatslimit erreicht oder zu viele AnfragenError
503Dienst vorübergehend nicht verfügbarError

GETStatus einer Reservierung

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

بمفتاح

المعاملات

ridpath · إلزامي
–

الردود

الكودالمعنىنموذج البيانات
200OKReservation
401Schlüssel fehlt oder ist ungültigError
403Zugang beendet (revoked)Error
404Nicht gefundenError
429Monatslimit erreicht oder zu viele AnfragenError
503Dienst vorübergehend nicht verfügbarError

GETVerbrauch und Kosten des laufenden Zeitraums

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

بمفتاح

الردود

الكودالمعنىنموذج البيانات
200OKUsage
401Schlüssel fehlt oder ist ungültigError
403Zugang beendet (revoked)Error
429Monatslimit erreicht oder zu viele AnfragenError
503Dienst vorübergehend nicht verfügbarError

GETZulassungsstellen und Zustand, optional nach Kürzel gefiltert (ohne Schlüssel)

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

دون مفتاح

المعاملات

codequery
–

الردود

الكودالمعنىنموذج البيانات
200OKOffices

GETFeste Szenarien der Sandbox (ohne Schlüssel)

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

دون مفتاح

الردود

الكودالمعنىنموذج البيانات
200OK–

GETDiese Beschreibung

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

دون مفتاح

الردود

الكودالمعنىنموذج البيانات
200OK–

GETDiese Beschreibung als Postman-Sammlung (ohne Schlüssel)

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

دون مفتاح

الردود

الكودالمعنىنموذج البيانات
200OK–

الإشعار الآلي (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
–

الردود

الكودالمعنىنموذج البيانات
200Jede 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>
–

ملفات للتحميل

أسئلة عن مرجع الربط البرمجي

هل هذا المرجع محدَّث دائماً؟
نعم. تُبنى الصفحة من ملف OpenAPI نفسه الذي تقدّمه الخدمة على /api/kc/v1/openapi.json، ويقارن اختبار بين الاثنين مع كل تعديل.
كيف أجرّب دون تكلفة؟
بمفتاح التجربة (wkz_sbx_). يعطي حالات ثابتة، ولا يسأل أي جهة رسمية، ولا يُحتسب.
ماذا يحدث فوق 120 طلباً في الدقيقة؟
يرد الربط البرمجي بالكود 429 مع الترويسة Retry-After، وفيها عدد الثواني حتى المحاولة التالية.
أي رد يُحتسب؟
الفحص الذي فيه إفادة من الجهة فقط (متاحة أو محجوزة). الردود دون إفادة وردود التجربة مجانية.

احصل على مفتاحك وابدأ