Integrujte validátor do svého nástroje pomocí API

V účtu Mailnatives si vytvořte tolik API klíčů, kolik jich potřebujete pro své intaegrace.

Na vstupu posíláte e-mail jako GET parametr, výsledky vracíme v JSON nebo XML - podle vaší potřeby.

Základní validace netrvá déle než 100ms, kompletní validace obvykle okolo 1s - záleží vždy na doméně.

Platíte jen za počet validací, žádný fix. Platba je možná kreditem nebo fakturou.

Aktuální plně podporovaná a doporučená verze je 3

https://api.mailcolm.com/

Struktura požadavku:

https://api.mailcolm.com/{version}/{method}/{email-address}/{output-format}/{test-filters}

Pomocí HTTP hlavičky, kde API klíč musí být base64 encoded:

Authorization: Basic {API_KEY}

Aktuálně jsou k dispozici pouze tyto metody:
- ping - pro testovací účely ověření autorizace
- validate - pro provedení samotné validace

Data mohou být vrácena ve formátu JSON nebo XML

Prováděné testy

Pokud není uvedeno jinak, ve výchozím nastavení se provedou všechny testy.

Pokud potřebujete určit, které testy se mají provést (pro zkrácení doby odezvy serveru), lze jako poslední parametr zadat následující názvy testů:
- typos – kontrola překlepů v názvu domény a návrh opravy
- smtp – kontrola DNS, stavu serveru a stavu doručitelnosti do schránky
- spamtrap – kontrola proti známým spamovým pastem
- disposable – kontrola jednorázových e-mailových služeb

Příklad jednoduché validace:

https://api.mailcolm.com/{version}/{method}/{email-address}/{output-format}

Příklady se specifikací testů:

https://api.mailcolm.com/{version}/{method}/{email-address}/{output-format}/typos
https://api.mailcolm.com/{version}/{method}/{email-address}/{output-format}/typos+smtp+disposable

REST API validátoru vrací HTTP/200, pokud byla validace provedena (bez ohledu na výsledek validace), a HTTP/40x, pokud validace provedena nebyla.
Nejčastější chybové kódy popsané v parametru mesg jsou:

HTTP/405 – Nedostatek kreditu, test nebyl proveden
HTTP/400 – Neplatné parametry, test nebyl proveden
HTTP/400 – API klíč je v aplikaci Mailcolm vypnutý. Přejděte do účtu Mailnatives a aktivujte svůj klíč.

Parametr email obsahuje původní e-mailovou adresu (řetězec), která byla použita pro validaci.

Parametr suggestion obsahuje návrh opravy, pokud byl zjištěn překlep.

Boolean hodnota validace:
1 – e-mailová adresa by měla existovat (score > 0)
0 – e-mailová adresa neexistuje

Parametr score je jednoduchý, ale nejdůležitější výsledek procesu validace e-mailu. score určuje úroveň platnosti e-mailové adresy:
1 – e-mailová adresa existuje
0.9 .. 0.1 – e-mailová adresa by měla existovat, ale poštovní server to nepotvrdil (míra pravděpodobnosti)
0 – e-mailová adresa je neplatná nebo neexistuje

Textový popis výsledku.

Parametr result popisuje výsledek testu podrobněji pomocí krátkého číselného kódu:
0 – Došlo k chybě s HTTP/40x, podrobnosti viz mesg
1 – Všechny testy proběhly úspěšně, e-mailová adresa je platná
2 – Zjištěn překlep
3 – Neplatná syntaxe pro danou doménu
4 – Doménové jméno neexistuje
5 – Nebyl nalezen poštovní server
6 – Adresa neexistuje
7 – Adresa je známá spamová past
8 – Jednorázová e-mailová adresa

Odpověď serveru může obsahovat i další neoficiální parametry, které podrobněji popisují výsledek a lze je využít při ladění (debugování).