Dokumentace API – Validace e-mailů

Webová služba pro validaci e-mailů je k dispozici na adrese

  • https://secure.smartform.cz/smartform-ws/validateEmail/v1

Autentizace

Služba využívá autentizační metodu Basic authentication. Jako jméno použijte uživatelské ID (clientId), které získáte po přihlášení do administrace v pravém horním rohu. Heslo si můžete zobrazit v administraci na záložce „Smartform Web Services“.

Při neúspěšné autentizaci vrací služba HTTP kód 401.

Vlastnosti dotazu

Dotazy musí být posílány metodou POST. Data jsou posílána ve formátu JSON s kódováním UTF-8.

Hlavička http requestu musí obsahovat následující položky:

název hodnota
Content-type application/json
Accept application/json

Struktura dotazu a odpovědi

Následuje referenční struktura dotazu a odpovědi. Objekty jsou zachyceny ve formě pseudokódu pro lepší pochopení struktury.

Dotaz

class ValidateEmailRequest
{
     // E-mailová adresa
     String emailAddress;
}

Odpověď

class ValidateEmailResponse
{
     // Výsledek dotazu
     ResultCode resultCode;

     // Detailní popis chyby (pokud je resultCode == FAIL)
     string errorMessage;

     // Výsledek validace
     ValidateEmailResult result;

     // Další informace o výsledku ověření
     List<ValidateEmailResultFlag> resultFlags;

     // Nápověda  pro doménovou část e-mailové adresy
     string hint;
}

Další objekty

/** Výsledek validace */            
enum ValidateEmailResult
{
     // E-mailová schránka existuje
     EXISTS,

     // E-mailová schránka neexistuje
     NOT_EXISTS,

     // Není jisté, zda e-mailová schránka existuje nebo ne
     UNKNOWN
}
/** Poskytuje další informace o zadané e-mailové adrese */ 
enum ValidateEmailResultFlag
{
     // Doručená pošta je plná, takže e-maily nelze doručit
     FULL_INBOX,

     // Špatná  syntaxe e-mailové adresy
     BAD_SYNTAX,

     // Nesprávná nebo neexistující doména e-mailové adresy
     BAD_DOMAIN,

     // Uživatel (místní část e-mailové adresy) neexistuje na poštovním serveru
     MAILBOX_NOT_FOUND,

     // Doména přijímá všechny e-maily. Nelze určit, jestli zadaná schránka existuje
     ACCEPT_ALL_POLICY,
    
     // Dočasná chyba, e-mailová adresa může být znovu ověřena později
     TEMPORARY
     
}
/** Výsledek dotazu. */ 
enum ResultCode
{
     // Volání service proběhlo v pořádku
     OK,

     // Při volání service došlo k chybě
     FAIL
}

Tabulka typů v pseudokódu

typ v pseudokódu typ v JSON
třída (class) vnořený objekt
výčet (enum) řetězec se jménem vybrané položky
List pole
Map objekt – klíče a hodnoty se stanou položkami objektu
string řetězec
int číslo
double číslo
boolean boolean
char (jeden znak) řetězec


Hlavní navigace: