PodporaAPI dokumentace

Úvod do API

Mailkit disponuje API rozhraním, založeném na standardech XML-RPC a JSON, které poskytuje přímý ověřený přístup k některým funkcím Mailkitu.

API akceptuje spojení pouze z povolených IP adres, které se nastavují a jsou uvedeny v nastavení integrace, přičemž samotné rozhraní je dostupné na adrese https://api.mailkit.eu/rpc.fcgi pro XML-RPC variantu, resp https://api.mailkit.eu/json.fcgi pro JSON variantu. Knihovny implementující API Mailkitu jsou k dispozici na stránkách https://github.com/mailkit.

Povinné náležitosti každého API volání

client_id - API ID naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.
client_md5 - MD5 kód naleznete ve svém Mailkit účtu v menu Profil / Integrace / Nastavení API.

Systém vrací čísla typu integer v <i4> nebo <i8> v závislosti na jejich výši.
<i4>: čísla >= -2147483648 až čísla <= 2147483647 
<i8>: čísla < -2147483648 a čísla > 2147483647

Maximální velikost jednoho API volání je 128 MB.

Příklady neúspěšného volání:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Unauthorized</string>
            </value>
        </param>
    </params>
</methodResponse>

JSON

{  
   "error_status":1,
   "error":"Unauthorized"
}

Důvod chyby

Unauthorized - vloženo nesprávné ID uživatele a/nebo vložen nesprávný MD5 kód

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Disallowed IP aaa.bbb.ccc.ddd</string>
            </value>
        </param>
    </params>
</methodResponse>

JSON

{  
   "error_status":1,
   "error":"Disallowed IP aaa.bbb.ccc.ddd"
}

Důvod chyby

Disallowed IP - IP adresa, ze které je prováděno volání není na seznamu povolených IP adres. Ve vašem účtu Mailkit v menu Profil / Integrace / Povolené IP adresy přidejte všechny IP adresy, ze kterých bude prováděno volání.

Doplňující chybové kódy

JSON rozhraní navíc vrací ke každé chybové zprávě chybový kód v hodnotě error_status. Pokud tato hodnota je jiná než 0, došlo k chybě.