Integrační manuál pro API - email

Endpoint

https://api.hukot.net/rest/%api-token%/%method%

Token získáte v administraci hostingu admin.hukot.net v části "API přístup".

Response zaslána jako JSON objekt, stav zpracování oznamován HTTP stavovým kódem - viz níže.
V případě chybě ve validaci hodnot je přidána hlavička ‘X-Error-Message’ s popisem chyby.

Kódování UTF-8. Přístup k API je omezen na zadané IP adresy a podléhá schválení ze strany poskytovatele.

HTTP stavové kódy

Odpověď	Popis
200	zpracování požadavku proběhlo úspěšně
400	chyba validace dat, více informací naleznete v HTTP hlavičce X-Error-Message
401	neoprávněný pokus o přístup k API; neplatný token nebo IP adresa
402	tarif daného objektu neumožňuje přidat více záznamů - viz X-Error-Message
404	požadovaný záznam nebyl nalezen
405	daná metoda API nepodporuje danou HTTP metodu; povoleny jsou pouze požadavky GET, POST, PUT a DELETE
409	záznam se shodným názvem již existuje
500	chyba serveru - služba je nedostupná, zpracování selhalo na straně serveru
501	metoda API není implementována

Datové typy

Typ	Popis
integer	libovolné celé číslo
array	pole objektů
string	jakýkoliv tisknutelný znak
boolean	hodnota nabývající 0, 1, true, false, TRUE nebo FALSE

Akce

Seznam e-mailových schránek:

Request:

curl -D - -o - https://api.hukot.net/rest/%api-token%/emails?[page=%pageNumber%] \
-X "GET"

Volitelný parametr page určuje odstránkování výsledků. Implicitní hodnota je rovna 0 (1. strana výsledků), maximálníhodnota je dána počtem záznamů v databázi.
Hodnotu maximální strany zjistíte vydělením hodnot totalCount s itemsPerPage a zaokrouhlením nahoru na celá čísla.

Response:

{"totalCount":174,"itemsPerPage":25,"data":["email@domain.cz"]}

Pole	Popis objektu	Datový typ
totalCount	Počet záznamů celkem	integer
itemsPerPage	Počet zobrazených záznamů na jedné stránce	integer
data	jednotlivé e-mailové adresy	array

Informace o jednotlivé schránce / aliasu

Request:

curl -D - -o - https://api.hukot.net/rest/%api-token%/email/ \
-X "GET"

Response:

{"name":"email@domena.cz", "type":1, "forwarding":["email@domena.cz"], "autoresponder":0, "autoresponderSubject":"", "autoresponderText":"", "antispam":1, "advancedSpamFiltering":0, "keepSpam":0, "spamTreshold":3, "spamHiTreshold":0, "dropHiScoringSpam":false, "blacklist":["spammer@domain.com"]}

Parametr	Popis	Datový typ
name	název schránky / aliasu	string
type	typ (1: fyzická schránka, 2: alias)	integer
forwarding	pole e-mailových adres, na které se bude zasílat kopie příchozích zpráv	array
autoresponder	aktivní automatická odpověď	boolean
autoresponderSubject	předmět automatické odpovědi	string
autoresponderText	text automatické odpovědi	string
antispam	stav antispamu	boolean
advancedSpamFiltering	rozšířené možnosti filtrování spamu	boolean
keepSpam	emaily vyhodnocené jako spam doručovat do IMAP adresáře Spam	boolean
spamTreshold	jako spam označit emaily s hodnocením vyšším než hodnota (SpamAssassin)	integer
spamHiTreshold	jako vysoce hodnocený spam označit emaily s hodnocením vyšším než hodnota (SpamAssassin)	integer
dropHiScoringSpam	zahodit vysoce hodnocený spam	boolean
blacklist	pole e-mailových adres, ze kterých je pošta automaticky zahozena	array

Smazání schránky / aliasu

Request:

curl -D - -o - https://api.hukot.net/rest/%api-token%/email/ \
-X "DELETE"

Vytvoření schránky

Request:

curl -N https://api.hukot.net/rest/%api-token%/email \
-X "POST" \
-H "Content-Type:application/x-www-form-urlencoded" -d "name=email@example.com&type=1"

Parametr	Popis	Datový typ
name*	název schránky / aliasu	string
password*	heslo	string
type*	typ (1: fyzická schránka)	integer [1]
forwarding	pole e-mailových adres, na které se bude zasílat kopie příchozích zpráv	boolean
autoresponder	aktivní automatická odpověď	boolean
autoresponderSubject	předmět automatické odpovědi	string
autoresponderText	text automatické odpovědi	string
antispam	stav antispamu	boolean
advancedSpamFiltering	rozšířené možnosti filtrování spamu	boolean
keepSpam	emaily vyhodnocené jako spam doručovat do IMAP adresáře Spam	boolean
spamTreshold	jako spam označit emaily s hodnocením vyšším než hodnota (SpamAssassin)	integer [1 - 25]
spamHiTreshold	jako vysoce hodnocený spam označit emaily s hodnocením vyšším než hodnota (SpamAssassin)	integer [1 - 25]
dropHiScoringSpam	zahodit vysoce hodnocený spam	integer
blacklist	pole e-mailových adres, ze kterých je pošta automaticky zahozena	array

Vytvoření aliasu

Request:

curl -N https://api.hukot.net/rest/%api-token%/email \
-X "POST" \
-H "Content-Type:application/x-www-form-urlencoded" -d "name=email@example.com&type=2"

Parametr	Popis	Datový typ
name*	název schránky / aliasu	string
type*	typ (2: alias)	integer [2]
forwarding	pole e-mailových adres, na které se bude zasílat kopie příchozích zpráv	boolean
autoresponder	aktivní automatická odpověď	boolean
autoresponderSubject	předmět automatické odpovědi	string
autoresponderText	text automatické odpovědi	string
antispam	stav antispamu	boolean
advancedSpamFiltering	rozšířené možnosti filtrování spamu	boolean
keepSpam	emaily vyhodnocené jako spam doručovat do IMAP adresáře Spam	boolean
spamTreshold	jako spam označit emaily s hodnocením vyšším než hodnota (SpamAssassin)	integer [1 - 25]
spamHiTreshold	jako vysoce hodnocený spam označit emaily s hodnocením vyšším než hodnota (SpamAssassin)	integer [1 - 25]
dropHiScoringSpam	zahodit vysoce hodnocený spam	integer

Editace schránky / aliasu

Request:

curl -N https://api.hukot.net/rest/%api-token%/email/ \
-X "PUT" \
-H "Content-Type:application/x-www-form-urlencoded" -d "autoresponder=1"

Parametr	Popis	Datový typ
forwarding	pole e-mailových adres, na které se bude zasílat kopie příchozích zpráv	array
password	heslo pouze pro fyzické schránky	string
autoresponder	aktivní automatická odpověď	boolean
autoresponderSubject	předmět automatické odpovědi	string
autoresponderText	text automatické odpovědi	string
antispam	stav antispamu pro další aktualizace antispamu je potřeba tento parametr posílat v každém požadavku	boolean
advancedSpamFiltering	rozšířené možnosti filtrování spamu	boolean
keepSpam	emaily vyhodnocené jako spam doručovat do IMAP adresáře Spam	boolean
spamTreshold	jako spam označit emaily s hodnocením vyšším než hodnota (SpamAssassin)	integer [1 - 25]
spamHiTreshold	jako vysoce hodnocený spam označit emaily s hodnocením vyšším než hodnota (SpamAssassin)	integer [1 - 25]
dropHiScoringSpam	zahodit vysoce hodnocený spam	boolean
blacklist	pole e-mailových adres, ze kterých je pošta automaticky zahozena	array