Tahák pro úpravu API metod pro správu kontaktů ze SE1 na SE2 Co je třeba mít na paměti: • XML-‐RPC API zůstává. Díky změně přístupu ke kontaktům se však mění metody. •
URL API se mění na https://app.smartemailing.cz/api/v2
•
Username zůstává stejný. Je vygenerován nový API token o délce 40 znaků.
•
Kontakty jsou v SE2 unikátní.
•
Hodnoty základních i vlastních polí kontaktů jsou tedy dostupné ve všech seznamech.
•
Pokud byl v SE1 kontakt ve více seznamech (jako více kontaktů se stejnou emailovou adresou), je převeden postupným sloučením těchto kontaktů do prvního z nich (jeho ID bude přeneseno, ostatní zanikají).
•
Vybraná globální vlastní pole (jméno, příjmení,...) se v SE2 mění na výchozí pole kontaktu (uživatelská vlastní pole zůstávají včetně svých ID).
•
ID seznamů jsou nezměněna.
•
SE2 přistupuje oproti SE1 jinak ke kampaním a smart kampaním. Vlastní obsah emailu je od kampaně a smart kampaně oddělený. Tento obsah pak lze použít opakovaně pro rozesílku kampaní i smart kampaní s možností editace na jednom místě.
•
Při převodu emailových kampaní je v ID rozesílky SE2 vyplněno hodnotou statid ze SE1. ID emailu v SE2 (tedy obsahu) je ID emailové kampaně ze SE1.
•
Při převodu smart kampaní je ID smart kampaně v SE2 shodné s ID v SE1. K ID emailu (tedy obsahu) je v SE2 připočten offset 1000000, aby nedocházelo ke kolizím s obsahy kampaní.
Kompletní dokumentaci včetně vzorových XML naleznete na http://www.smartemailing.cz/api/
Práce s kontakty Staré metody pro přídávání, aktualizaci a odstranění kontaktu se seznamu jsou nově nahrazeny jedinou metodou Contacts::createupdate
Stará metoda ze SE1 (V SE2 NEFUNKČNÍ) <xmlrequest> <username>mycroft <usertoken>c0d646874b2153d236a4d1816e3501176c69c5ce <requesttype>sm_subscribers <requestmethod>AddSubscribers <details>
<details> <emailaddress>[email protected] <mailinglist>50 html 1 <status>active <customfields> - 2 Martin
- 3 Strouhal
- 12345 Moje vlastní pole
Nová metoda v SE2: <xmlrequest> <username>mycroft <usertoken>novy_xml_token_o_delce_40_znaku <requesttype>Contacts <requestmethod>createupdate <details> V SE2 byla některá globální vlastní pole nahrazena přímo vlastnostmi kontaktu. Tabulka pro převod vlastních polí na vlastnosti kontaktu ve tvaru ID pole => název vlastnosti: $defaultFields = [ 1 => 'salution', 2 => 'name', 3 => 'surname', 4 => 'phone', 5 => 'cellphone', 8 => 'town', 10 => 'postalcode', 11 => 'country', 17 => 'company', 20 => 'street', 548 => 'notes', // 1623 => 'nameday', // admin.smartemailing.cz // 1510 => 'nameday', // admin2.smartemailing.cz // 1186 => 'nameday', // admin3.smartemailing.cz ]; -‐-‐> <emailaddress>
[email protected] cs_CZ 0 Martin <surname>Strouhal
Ing. Csc. 2013-‐01-‐01 2013-‐11-‐11 <salution>
My Corp <street>Long 123
My Town Czech Republic <postalcode>123456 <notes>Something very long
+420123456789 +420123456789 <customfields>
- 12345 Hodnota v mém vlastním poli
- 21 <status>unsubscribed
- 50 <status>confirmed
Získání informací o kontaktu Jediná metoda SE2 API zjistí data kontaktu a přiřazení k seznamům. Tato metoda nahrazuje několik metod v SE1. Jako vyhledávací klíč slouží ID kontaktu nebo emailová adresa.
Staré metody v SE1 (V SE20 NEFUNKČNÍ) <xmlrequest> <username>mycroft <usertoken>c0d646874b2153d236a4d1816e3501176c69c5ce <requesttype>sm_subscribers <requestmethod>GetSubscriber <details> <subscriberid>25238 <xmlrequest> <username>mycroft <usertoken>c0d646874b2153d236a4d1816e3501176c69c5ce <requesttype>sm_subscribers <requestmethod>GetSubscriberByEmail <details> <emailaddress>
[email protected] <listid>1304 <xmlrequest> <username>mycroft <usertoken>c0d646874b2153d236a4d1816e3501176c69c5ce <requesttype>sm_lists <requestmethod>IsSubscriberInList <details> <emailaddress>
[email protected] <mailinglistid>759
Nová metoda v SE2 nahrazující předchozí 3 metody <xmlrequest> <username>mycroft <usertoken>novy_xml_token_o_delce_40_znaku <requesttype>Contacts <requestmethod>getOne <details>
25238 [email protected] -‐-‐>
Vzorová odpověď serveru:
<status>SUCCESS cs_CZ 2013-‐05-‐13 17:03:28 2013-‐05-‐13 17:26:59 0 <emailaddress>[email protected] <domain>smartemailing.cz Lukáš <surname>Pour <salution>Martine <street>ulice 123 <postalcode/> <notes/> <softbounced>0 0 25238 <customfields> - 12345
- Hodnota v mém vlastním poli
- 48
- Jiná hodnota v jiném vlastním poli
- 10 <status>confirmed 2013-‐05-‐13 17:03:28
- 13 <status>unsubscribed 2013-‐05-‐17 17:03:28
