Konfigurera webhooks
En webhook låter VerifyPDF anropa din egen URL när ett verifieringsresultat är klart, så ditt system notifieras istället för att fråga om och om igen. Ange en https-URL per API-nyckel.
En webhook är ett sätt för VerifyPDF att tala om för ditt system att ett resultat är klart, istället för att ditt system frågar om och om igen. Den här artikeln förklarar idén och hur du slår på den.
Vad en webhook är, i klartext
När du verifierar ett dokument är resultatet inte alltid klart direkt. Utan en webhook måste ditt system fortsätta kolla, “är det klart än?” Det kallas polling.
En webhook vänder på det. Du ger VerifyPDF en URL på ditt eget system. När ett resultat är klart anropar VerifyPDF den URL:en och skickar utfallet till dig. Ditt system reagerar på anropet istället för att fråga efter ändringar.
Ange en webhook-URL per nyckel
Varje API-nyckel kan ha sin egen webhook-URL. Du anger den i dashboarden:
- Logga in på secure.verifypdf.com och öppna Developers i sidofältet till vänster.
- Välj den API-nyckel du vill använda och redigera dess webhook-URL.
- Spara. URL:en måste börja med https://.
Eftersom URL:en anges per nyckel kan du dirigera notiser från olika integrationer till olika endpoints, till exempel en test-nyckel som pekar mot en test-URL och en live-nyckel mot din produktions-URL. Se Test- kontra live-API-nycklar.
För att stänga av webhooks för en nyckel, lämna URL-fältet tomt och spara.
Vad VerifyPDF skickar
När en verifiering är klar anropar VerifyPDF din webhook-URL så att ditt system kan agera på resultatet, till exempel uppdatera ett ärende eller varna en granskare. För den exakta payloaden och hur du verifierar att ett anrop verkligen kom från VerifyPDF, se API-referensen på /agents/ och dokumentationen i Developers i dashboarden.
Nästa steg
- Behöver du en nyckel först? Se Skapa och hantera API-nycklar.
- Vill du ha hela sändningsflödet? Se Verifiera ett dokument med API:et.