Prevádzka programátorského rozhrania (API)

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í.

Základné pokyny prevádzkového princípu

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.

Referencie - volania API URL

Medzi parametre neuvedieme dve povinné parametre (uid,pwd). Hodnotu parametrov s kódovaním UTF-8 treba zadať a URL kódovať.