S označením API funguje URL s danými parametrami a dá sa teda parametricky modifikovať. Výsledkom je v jedinečnom reťazci URL, vytvorá kódovaním jednotlivých spárovaných premenných a hodnôt. Tento spôsob sa dá výnimočne jednoducho používať na ľubovoľnej platforme a v programátorskom prostredí.
K jednému z najčastejšie rozšírených programátorských jazykov, k php priložíme ako príklad aj programové kódy . Podľa príkladového kódu php sa dá kód poľahky napísať aj v inom jazyku.
API nie je obsiahle,teda nie je možné dosiahnuť s ním všetky funkcie ListMaestro e-mailu, a pre tento účel to väčšinou ani nie je potrebné. Momentálne obsiahnuteľné funkcie slúžia na manipuláciu s členmi skupiny (zapisovanie, odhlasovanie,vyhľadávanie údajov a prispôsobenie). API nepodporuje posielanie listov a zmeny rôznych nastavení.
V ListMaestro e-maili sú údaje viazané ku skupinám, a tak sú aj ukladané (skupina v ListMaestro e-maili môže byť zoznam adries alebo dotazník). Každá skupina môže mať rôzné dátové pole, ale dve dátové polia sú vždy povinné: meno a emailová adresa. Na jednotlivé dátové polia, bez mena, sa odvoláme v API žiadostiach, ale každé pole má jeden jednoduchý (aj čísla obsahujúci) identifikátor (napr. "f734"). Identifikátor odvolávajúci sa na meno a emailovú adresu je vždyprítomný "name" a "email". Identifikátormi skupín a identifikátormi polí v jednej žiadosti môžeme stiahnuť celú údajovú databázu. Na toto slúži "listFieldIDs" príkaz.
Pri každom jednom vyvolaní URL sú potrebné overené údaje, teda identifikačné číslo používateľa a tvar kódovaného hesla. Toto sú "uid" a "pwd" parametre. Oprávnenosť tohto úkonu je stále kontrolovaná. Hodnoty parametrov si majiteľ zoznamu vie pozrieť v menu "Nastavenia -> Programátorské rozhranie" . Ich znalosť neumožní prístup k ListMaestro e-mailovej schránke pre programátora celkovo, nebude s Vami vedieť vstúpiť do webovej lokality, ale prostredníctvom podpory aplikácií API : budeťe vidieť všetky informácie, zoznamy adries, napr.
Ostatné povinné paratmetre "cmd" určí aktuálný typ pokynu , (napr. getMemberData stiahnutie údaje člena skupiny). Jednotlivé pokyny si vyžiadajú rôzne parametre (napr. pre getMemberData je potrebný identifikátor "mid" člena skupiny, čo sme si stiahnutím pokynu getAllMembers už vyžiadali). Presný zápis parametrov zadáme v nižšie uvedenom Referenčnom úseku .
Hodnota spätne prichádzajúcich volaní obsahuje vždy jeden status menovanej premennej, ktorej hodnota je, v prípade správneho priebehu, "OK", v prípade chyby "ERR", alebo figuruje ako jedna premenná,zvaná msg, v ktorej je jedna poruchová správa v anglickom jazyku o príčine chyby (alebo "Done" keď je status="OK").
V nižšie uvedenom referenčnom úseku sa náchádza príklad : URL-y fungujú, s pomocou vyhľadávača môžeme hneď skúšať volania na jednej testovacej databáze. Je pochopiteľné, že sa môžu vo výsledku z celkového počtu volaní vyskytnúť aj chybné volania, súvisiace s tým, v akom stave sa teraz testovacia databáza nachádza.
Medzi parametre neuvedieme dve povinné parametre (uid,pwd). Hodnotu parametrov s kódovaním UTF-8 treba zadať a URL kódovať.
Funkcie: Stiahnutie prehliadaných informácií z celej údajovej databázy.
Tento pokyn, odlišný od ostatných, nie je zvyčajne v URL kódovanom formáte, prinesie späť vysledok, ale v obyčajnom texte. Nie je vhodný na dalšie strojové spracovanie, jeho úlohou je iba to, aby našiel pre vyvojára skupinám patriace identifikátory, identifikátory listov a filtrov. Výsledok oznámi všetky potrebné informácie, takže triedi všetky skupiny podľa na nich sa nachádzajúcich a na ne sa odvolávajúcich zapisovacich polí a mien,
Príklad URL volanie:
http://sk.listmaestro.com/lmui/faces/api/Call.jsp?uid=984&pwd=39e0d4e70a123c9f001e13d6d7967142&cmd=listFieldIDs
Funkcie: Triedenie členov skupín podľa základných údajov (email, meno, memberID)
Formát výsledku je jeden (dlhý podľa potreby) zoznam s nižšie uvedenímy premennými:
Napríklad URL volanie:
http://sk.listmaestro.com/lmui/faces/api/Call.jsp?uid=984&pwd=39e0d4e70a123c9f001e13d6d7967142&cmd=getAllMembers&gid=1337
Funkcie: Stiahnutie všetkých zapisovacích údajov člena
Identifikátor člena skupiny je v systéme individuálne, teda je zbytočné udávať identifikátora skupiny. Formát výsledku je zoznam nižšie uvedených premenných:
Napríklad pri URL volaní:
http://sk.listmaestro.com/lmui/faces/api/Call.jsp?uid=984&pwd=39e0d4e70a123c9f001e13d6d7967142&cmd=getMemberData&mid=629006
Funkcie: Prijatie nového člena do skupiny.
Nie je povinné udať fXX parametre, ale meno a email parametre sú vždy povinné. Keď dáme viac odpovedí na jedno pole umožňjúce viacero odpovedí, tieto je potrebné oddeliť pred URL kódovaním formovaním jednotlivých znakov "\n" .
Napríklad URL volanie:
http://sk.listmaestro.com/lmui/faces/api/Call.jsp?uid=984&pwd=39e0d4e70a123c9f001e13d6d7967142&cmd=saveMember&gid=1337&name=Gipsz+Jakab&email=gipsz.jakab12%40gjakab.hu&f1496=Ukrajna
Funkcie: Upravovanie údajov existujúcich členov.
Vo funkčnosti sa zhoduje s saveMemberrel. Člena neidentifikujeme s jedinečným mid-om, ale s jeho emailovou adresou (v jednej skupine sa môže vyskytnúť jedna emailová adresa len raz). Preto sú emailové parametre povinné.
Príklad URL volania:
http://sk.listmaestro.com/lmui/faces/api/Call.jsp?uid=984&pwd=39e0d4e70a123c9f001e13d6d7967142&cmd=modifyMember&gid=1337&name=Jakab&email=gipsz.jakab12%40gjakab.hu&f1496=Ausztria
Funkcie: Odhlásenie existujúceho člena zo skupiny.
Člena identifikujeme podľa emailovej adresy. V prípade odhlásenia sa bude mať v dátabáze stopu, že on už raz bol členom skupiny, Toto je praktické, pri opätovnom hromadnom zapisovaní adries. V prípade, že by bývalý člen nechcel byť znova prijatý na zoznam.
Príklad URL volanie:
http://sk.listmaestro.com/lmui/faces/api/Call.jsp?uid=984&pwd=39e0d4e70a123c9f001e13d6d7967142&cmd=unsubscribeMember&gid=1337&email=gipsz.jakab12%40gjakab.hu
Funkcie: Posielanie emailov jednej skupine.
List a jeho voliteľne používané identifikátory filtra listFields vieme s funkciou odpísať. Pozor: pri používaní väčšej rýchlosti posielania listov kvôli kritickému limitu prijímajúcých serverov (spam filtre) sa neodporúča . Na základe definovanej hodnoty je vhodné používat max. niekoľkokrát, iba v súrnych prípadoch.
Príklad URL volanie:
http://sk.listmaestro.com/lmui/faces/api/Call.jsp?uid=984&pwd=39e0d4e70a123c9f001e13d6d7967142&cmd=sendMailToGroup&gid=1337&eid=10197&fid=813
Funkcia: Štatistika otváraní e-mailov.
Výsledkom funckie je čistý text, ktorý v každom rade obsahuje udalosť pri otváraní vo formáte:
1. stĺp: e-mailová adresa
2. stĺp: počet otváraní
3. stĺp: dátum (obsahuje medzeru)
Funkcia: Štatistika kliknutí na link obsahovej stránky.
Výsledkom funckie je čistý text, ktorý v každom rade obsahuje udalosť pri otváraní vo formáte:
1. stĺp: e-mailová adresa
2. stĺp: počet kliknutí
3. stĺp: dátum (obsahuje medzeru)
Funkcia: Tvorí novú skupinu podľa existujúcej skupiny. Dátové polia sú kopírované, avšak členovia nie.
Formát výsledku:
Napríklad URL volanie:
http://sk.listmaestro.com/lmui/faces/api/Call.jsp?uid=984&pwd=39e0d4e70a123c9f001e13d6d7967142&cmd=createGroup&gid=1337&name=testNovejSkupiny