Skonfiguruj webhooki
Webhook pozwala VerifyPDF wywołać twój własny adres URL, gdy wynik weryfikacji jest gotowy, więc twój system jest powiadamiany zamiast odpytywać. Ustaw adres https na każdy klucz API.
Webhook to sposób, w jaki VerifyPDF informuje twój system, że wynik jest gotowy, zamiast żeby twój system pytał o to w kółko. Ten artykuł wyjaśnia tę ideę i jak ją włączyć.
Czym jest webhook, prostymi słowami
Gdy weryfikujesz dokument, wynik nie zawsze jest gotowy natychmiast. Bez webhooka twój system musi w kółko sprawdzać: “czy już gotowe?”. To się nazywa odpytywanie.
Webhook to odwraca. Dajesz VerifyPDF adres URL w twoim własnym systemie. Gdy wynik jest gotowy, VerifyPDF wywołuje ten adres URL i wysyła ci rezultat. Twój system reaguje na wywołanie, zamiast odpytywać o zmiany.
Ustaw adres URL webhooka na każdy klucz
Każdy klucz API może mieć własny adres URL webhooka. Ustawiasz go w panelu:
- Zaloguj się na secure.verifypdf.com i otwórz Developers na lewym pasku bocznym.
- Wybierz klucz API, którego chcesz użyć, i edytuj jego adres URL webhooka.
- Zapisz. Adres URL musi zaczynać się od https://.
Ponieważ adres URL ustawiany jest osobno dla każdego klucza, możesz kierować powiadomienia z różnych integracji do różnych punktów końcowych, na przykład klucz testowy wskazujący na testowy adres URL, a klucz produkcyjny na twój produkcyjny adres URL. Zobacz Klucze API testowe i produkcyjne.
Aby wyłączyć webhooki dla klucza, zostaw pole adresu URL puste i zapisz.
Co wysyła VerifyPDF
Gdy weryfikacja się kończy, VerifyPDF wywołuje twój adres URL webhooka, aby twój system mógł zadziałać na podstawie wyniku, na przykład aktualizując sprawę albo powiadamiając osobę weryfikującą. Aby poznać dokładny ładunek i sposób sprawdzenia, czy wywołanie naprawdę pochodzi z VerifyPDF, zobacz dokumentację API pod /agents/ oraz dokumentację Developers w panelu.
Następne kroki
- Najpierw potrzebujesz klucza? Zobacz Generuj klucze API i zarządzaj nimi.
- Chcesz pełny proces wysyłania? Zobacz Zweryfikuj dokument za pomocą API.