Dokumenty API sprawdzania poprawności wiadomości e-mail
Pierwsze kroki
Wszystkie żądania API wymagają uwierzytelnienia przy użyciu klucza API. Klucz API można znaleźć na pulpicie nawigacyjnym.
Nagłówek: "x-api-key: your-api-key"Pojedyncza weryfikacja
Zweryfikuj pojedynczy adres e-mail lub domenę pod kątem ważności, statusu jednorazowego użytku, usług prywatności i dostarczalności.
Punkt końcowy
GET /v1/verifyParametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| input | string | Tak | Adres e-mail lub domena do weryfikacji (np. [email protected] lub example.com) |
apiDocs.responseFields
| Pole | Opis |
|---|---|
| valid | Wskazuje, czy format wiadomości e-mail jest poprawny |
| block | Wskazuje, czy wiadomość e-mail powinna zostać zablokowana (prawda, jeśli wartość disposable, privacy, applePrivateEmail, deliverable lub catch_all jest prawdziwa). |
| disposable | Określa, czy adres e-mail jest tymczasowy czy jednorazowy. |
| privacy | Określa, czy serwer pocztowy korzysta z aliasu e-mail lub forwardera. |
| applePrivateEmail | Wskazuje, czy adres e-mail jest adresem Apple Private. |
| deliverable | Sprawdza, czy skrzynka pocztowa istnieje i może odbierać wiadomości e-mail |
| domain | Część domenowa adresu e-mail |
| email_address | Adres e-mail |
| catch_all | Wskazuje, czy domena ma konfigurację poczty e-mail typu "catch-all", która akceptuje wszystkie przychodzące wiadomości e-mail niezależnie od adresu odbiorcy. |
| mx_found | Wskazuje, czy domena ma prawidłowe serwery pocztowe (rekordy MX). |
| remaining_credits | Liczba kredytów API pozostałych na koncie użytkownika |
Przykładowa odpowiedź
{
"valid": true,
"block": false,
"disposable": false,
"privacy": false,
"applePrivateEmail": false,
"deliverable": true,
"domain": "example.com",
"email_address": "[email protected]",
"catch_all": false,
"mx_found": true,
"error": null,
"remaining_credits": 99
}Przykłady kodu
curl "https://api.verify-email.app/v1/[email protected]" \
-H "X-API-Key: your-api-key"Wypróbuj
Do testowania punktów końcowych potrzebny jest klucz API.
Spróbuj z:
Weryfikacja partii
Weryfikacja wielu adresów e-mail lub domen w jednym żądaniu (maksymalnie 100 elementów).
Punkt końcowy
POST /v1/verify/batchParametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| inputs | array of strings | Tak | Tablica adresów e-mail lub domen do zweryfikowania |
Przykłady kodu
curl -X POST "https://api.verify-email.app/v1/verify/batch" \
-H "Content-Type: application/json" \
-H "X-API-Key: your-api-key" \
-d '{
"inputs": [
"[email protected]",
"[email protected]"
]
}'Wypróbuj
Do testowania punktów końcowych potrzebny jest klucz API.
Spróbuj z różnymi domenami: