Kiedy użyć API
Publiczne API DeliverIQ służy do pojedynczej walidacji adresu e-mail przez
POST /api/v1/verify. Użyj go wtedy, gdy chcesz włączyć sprawdzanie adresów
do własnego backendu, formularza rejestracji, procesu importu leadów albo wewnętrznego narzędzia.
API obsługuje tryby light i deep. Do wywołania potrzebujesz
aktywnego klucza API, dostępnych kredytów oraz żądania, które nie jest zatrzymane przez
limity i politykę bezpieczeństwa. Publiczne API walidacji masowej nie jest obecnie dostępne;
listy CSV/TXT sprawdza się w panelu w module Walidacja masowa.
Przykładowe zastosowania
API jest przydatne zwłaszcza tam, gdzie sprawdzasz pojedynczy adres w reakcji na zdarzenie w swoim systemie.
- Formularze rejestracji: sprawdzenie składni, domen tymczasowych i literówek zanim zapiszesz adres w bazie.
- Import pojedynczych leadów: walidacja adresu dodawanego ręcznie przez zespół sprzedaży albo przez własny backend.
- Procesy CRM i marketing automation: wywołanie API z własnej integracji serwerowej przed dodaniem kontaktu do aktywnej sekwencji.
DeliverIQ nie udostępnia obecnie gotowych konektorów ani wychodzących webhooków klienckich. Integracja powinna być zaimplementowana po stronie Twojego backendu.
Klucze API
Każde żądanie do publicznego API wymaga nagłówka
Authorization: Bearer <api_key>. Klucze tworzysz i unieważniasz w panelu
Klucze API.
Idempotencja i bezpieczne ponawianie żądań
POST /api/v1/verify wymaga nagłówka Idempotency-Key. Używaj jednego
unikalnego klucza dla jednej biznesowej próby walidacji. Jeśli połączenie zostanie przerwane,
możesz ponowić identyczne żądanie z tym samym kluczem.
Identyczne żądanie z tym samym kluczem, które zostało już zakończone, zwraca zapisany rezultat
bez ponownego naliczenia kredytów. Użycie tego samego klucza z innym payloadem zwraca konflikt.
Gdy pierwsze żądanie nadal trwa, API zwraca 409 IDEMPOTENCY_CONFLICT; ponów próbę
później z tym samym kluczem i identycznym payloadem.
Pełna Dokumentacja API
Szczegółowy, aktualny kontrakt requestów i odpowiedzi znajdziesz w panelu pod adresem Dokumentacja API. To właściwe źródło dla nazw pól, kodów błędów, statusów i przykładów JSON.
Strona Dokumentacja API w panelu wymaga zalogowania. Interaktywne /docs może być dostępne publicznie zależnie od konfiguracji środowiska.