Tato API funkce však není primárně určena k plnění seznamu příjemců, ale jako nástroj pro hromadné aktualizace. Pro synchronizaci s informačními systémy doporučujeme využívat datové zdroje, které umožňují jednodušší a flexibilnější implementaci, která je časově méně náročná na realizaci.
Ukázka API volání:
JSON
{
"function":"mailkit.mailinglist.import",
"id":"client_id",
"md5":"client_md5",
"parameters":{
"ID_user_list":ID_user_list,
"recipients":[
{
"street":"adresa",
"custom16":"vlastní pole č. 16",
"nick_name":"přezdívka",
"custom3":"vlastní pole č. 3",
"state":"země",
"email":"email@example.eu",
"custom17":"vlastní pole č. 17",
"custom20":"vlastní pole č. 20",
"vocative":"oslovení",
"custom19":"vlastní pole č. 19",
"custom12":"vlastní pole č. 12",
"custom1":"vlastní pole č. 1",
"custom22":"vlastní pole č. 22",
"zip":"PSČ",
"custom2":"vlastní pole č. 2",
"custom23":"vlastní pole č. 23",
"custom18":"vlastní pole č. 18",
"custom13":"vlastní pole č. 13",
"custom25":"vlastní pole č. 25",
"mobile":"mobil",
"last_name":"příjmení",
"custom6":"vlastní pole č. 6",
"city":"město",
"fax":"fax",
"custom5":"vlastní pole č. 5",
"company":"firma",
"gender":"m",
"country":"kraj/stát",
"custom24":"vlastní pole č. 24",
"custom4":"vlastní pole č. 4",
"custom9":"vlastní pole č. 9",
"custom15":"vlastní pole č. 15",
"custom10":"vlastní pole č. 10",
"phone":"telefon",
"custom11":"vlastní pole č. 11",
"custom21":"vlastní pole č. 21",
"custom7":"vlastní pole č. 7",
"custom14":"vlastní pole č. 14",
"reply_to":"email2@example.eu",
"custom8":"vlastní pole č. 8",
"first_name":"jméno",
"prefix":"titul"
},
{
"email":"email@example.com",
"first_name":"jméno",
"last_name":"příjmení"
}
]
}
}
XML
<?xml version="1.0"?>
<methodCall>
<methodName>mailkit.mailinglist.import</methodName>
<params>
<param>
<value>
<int>client_id</int>
</value>
</param>
<param>
<value>
<string>client_md5</string>
</value>
</param>
<param>
<value>
<int>ID_user_list</int>
</value>
</param>
<param>
<value>
<array>
<data>
<!-- začátek 1. příjemce -->
<value>
<struct>
<member>
<name>first_name</name>
<value>
<string>Jméno</string>
</value>
</member>
<member>
<name>last_name</name>
<value>
<string>Příjmení</string>
</value>
</member>
<member>
<name>email</name>
<value>
<string>mail@mail.cz</string>
</value>
</member>
<member>
<name>company</name>
<value>
<string>firma</string>
</value>
</member>
<member>
<name>prefix</name>
<value>
<string>titul</string>
</value>
</member>
<member>
<name>vocative</name>
<value>
<string>oslovení</string>
</value>
</member>
<member>
<name>reply_to</name>
<value>
<string>mail@mail.cz</string>
</value>
</member>
<member>
<name>nick_name</name>
<value>
<string>přezdívka</string>
</value>
</member>
<member>
<name>gender</name>
<value>
<string>pohlaví</string>
</value>
</member>
<member>
<name>phone</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>mobile</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>fax</name>
<value>
<string>12345</string>
</value>
</member>
<member>
<name>street</name>
<value>
<string>adresa</string>
</value>
</member>
<member>
<name>city</name>
<value>
<string>město</string>
</value>
</member>
<member>
<name>state</name>
<value>
<string>země</string>
</value>
</member>
<member>
<name>country</name>
<value>
<string>kraj</string>
</value>
</member>
<member>
<name>zip</name>
<value>
<string>PSČ</string>
</value>
</member>
<member>
<name>custom1</name>
<value>
<string>vlastní pole č. 1</string>
</value>
</member>
<member>
<name>customX</name>
<value>
<string>vlastní pole č. X</string>
</value>
</member>
</struct>
</value>
<!-- konec 1. příjemce a začátek 2. příjemce-->
<value>
<struct>
<member>
<name>email</name>
<value>
<string>mail2@mail.cz</string>
</value>
</member>
</struct>
</value>
<!-- konec 2. příjemce -->
</data>
</array>
</value>
</param>
</params>
</methodCall>
Hodnoty
client_id * = API ID naleznete ve svém Mailkit účtu v menu Profil/Integrace.
client_md5 * = MD5 kód naleznete ve svém Mailkit účtu v menu Profil/Integrace.
ID_user_list * = ID seznamu příjemců
first_name = jméno příjemce
last_name = příjmení příjemce
email * = e-mailová adresa příjemce
company = firma příjemce
prefix = titul příjemce
vocative = oslovení příjemce
reply_to = e-mailová adresa pro odpověď příjemce
nick_name = přezdívka příjemce
gender = pohlaví příjemce příjemce. Může nabývat hodnot male/female; m/f; muz/zena; M/F
phone = telefon příjemce
mobile = mobil příjemce
fax = fax příjemce
street = adresa (ulice) příjemce
city = město příjemce
state = země příjemce
country = kraj příjemce
zip = PSČ příjemce
custom1 = vlastní pole příjemce č. 1. Celkový počet vlastních polí je 25.
* povinný parametr
Po úspěšném volání se vrací:
JSON
{
"invalid_emails": [],
"count_new": "10",
"error_status": 0,
"count_bad": "0",
"count_all": "20",
"count_updated": "10"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string>w/x/y/z</string>
</value>
</param>
</params>
</methodResponse>
Hodnoty pro JSON
invalid_emails = neplatné adresy
count_new = nové adresy
error_status = chybový stav
count_bad = počet neplatných adres
count_all = celkový počet adres
count_updated = počet aktualizovaných adres
Hodnoty pro XML
w = celkový počet importovaných adres
x = počet nově vložených adres
y = počet aktualizovaných adres
z = počet neplatných adres
Příklad neúspěšného volání:
JSON
{
"error_status": 1,
"error": "Invalid ID_user_list"
}
XML
<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param>
<value>
<string>Wrong ID_mailing_list</string>
</value>
</param>
</params>
</methodResponse>
Hodnoty
Invalid ID_user_list = neplatné ID seznamu příjemců (pro JSON)
Missing ID_user_list = chybí ID seznamu příjemců (pro JSON)
Wrong ID_mailing_list = vloženo špatné nebo neexistující ID seznamu příjemců (pro XML)
