Webhooks einrichten
Ein Webhook lässt VerifyPDF deine URL aufrufen, wenn ein Ergebnis bereit ist, sodass dein System benachrichtigt wird statt zu pollen. Setze eine https-URL pro API-Schlüssel.
Ein Webhook ist eine Möglichkeit für VerifyPDF, deinem System mitzuteilen, dass ein Ergebnis bereit ist, statt dass dein System immer wieder nachfragt. Dieser Artikel erklärt die Idee und wie du sie einschaltest.
Was ein Webhook ist, einfach erklärt
Wenn du ein Dokument verifizierst, ist das Ergebnis nicht immer sofort bereit. Ohne einen Webhook muss dein System ständig nachfragen: “Ist es schon fertig?” Das nennt man Polling.
Ein Webhook dreht das um. Du gibst VerifyPDF eine URL auf deinem eigenen System. Wenn ein Ergebnis bereit ist, ruft VerifyPDF diese URL auf und sendet dir das Ergebnis. Dein System reagiert auf den Aufruf, statt auf Änderungen zu pollen.
Eine Webhook-URL pro Schlüssel setzen
Jeder API-Schlüssel kann seine eigene Webhook-URL haben. Du setzt sie im Dashboard:
- Melde dich unter secure.verifypdf.com an und öffne Developers in der linken Seitenleiste.
- Wähle den API-Schlüssel, den du nutzen willst, und bearbeite seine Webhook-URL.
- Speichere. Die URL muss mit https:// beginnen.
Weil die URL pro Schlüssel gesetzt wird, kannst du Benachrichtigungen aus verschiedenen Integrationen an verschiedene Endpunkte leiten, zum Beispiel einen test-Schlüssel auf eine Test-URL und einen live-Schlüssel auf deine Produktions-URL. Sieh dir Test- vs. Live-API-Schlüssel an.
Um Webhooks für einen Schlüssel auszuschalten, lass das URL-Feld leer und speichere.
Was VerifyPDF sendet
Wenn eine Verifizierung fertig ist, ruft VerifyPDF deine Webhook-URL auf, damit dein System auf das Ergebnis reagieren kann, zum Beispiel einen Fall aktualisieren oder eine prüfende Person benachrichtigen. Für die genaue Payload und wie du überprüfst, dass ein Aufruf wirklich von VerifyPDF kam, sieh dir die API-Referenz unter /agents/ und die Developers-Dokumentation im Dashboard an.
Nächste Schritte
- Brauchst du zuerst einen Schlüssel? Sieh dir API-Schlüssel erstellen und verwalten an.
- Willst du den vollständigen Sendeablauf? Sieh dir Ein Dokument mit der API verifizieren an.