Systém umožňuje napojení pomocí tzv. API protokolu.

Toto napojení probíhá přes HTTP/HTTPS protokol (doporučujeme šifrované HTTPS) na základě WSDL schématu (popis služby API).

URL adresa API a WSDL schématu se odvíjí od použité verze. Konkrétní URL adresu najdete v detailu napojení (administrace eshopu / nastavení / API / detail kontrétního napojení / pole "URL adresa")

 

1. Začíname

1.1 Vytvoření nového API

V administraci eshopu / nastavení / API přejdeme do pravého menu a klikneme na položku "Vytvořit přístup k API".

Následně vyplníme příslušná pole.

Pole verze umožňuje vybrat verzi, kterou bude propojení používat. Je možné používat vždy nejnovější verzi.

Vy výjimečných případech je možné se vždy vrátit na některou z předchozích verzí API. Například kvůli kompatibilitě.

Pole "Seznam IP adres, které mohou  používat API"  - jedná sa o tzv. whitelist. Pokud není toto pole prázdné bude systém ověřovat zda se IP adresa klienta nachází mezi povolenými. Pokud se IP adresa nebude necházet v seznamu povolených, vrátí API chybu a komunikace se ukončí.

 

Po vyplnění příslušných polí klikneme na tlačítko "vložiť".

1.2 Nastavení práv

Po úspěšném vložení nového API propojení je možné nastavit přístupová práva. V seznamu API propojení klikneme na tlačítko "editace práv".

Následně sa nám zobrazí všechny metody tohoto API propojení (v závislosti na použité verzi).

Pokud nebudou nastavená žádná práva, API po zavolání příslušné metody vrátí chybu.

Popis jednotlivých metod naleznete v technické dokumentaci příslušné verze.

 

Po nastavení práv máte API úspešně nastavené a můžete Vašemu programátorovi zaslat technickou dokumentaci.

 

2. Logy

V administráci eshopu / nastavení / API / pravé menu, položka "Logy" sa nachází seznam přístupů k API.

Logy se uchovávají nejvýše 6 měsíců.

Logy obsahují informácie o IP adrese klienta, datumu  a času přístupu klienta a informace o akci, kterou požadoval vykonat. V některých případech se může klientovi vrátit chyba. Pokud tento případ nastane, v logu se zobrazí informace o tom, že nastala chyba a kod příslušné chyby.

V logu je taktéž možné zobrazit hlavičku požadavku (pro konrolu přihlášení) a parametry zaslané v požadavku (číslo, řetězec, objekt apod.).

 

3. Globální nastavení

V administráci eshopu / nastavení / API / pravé menu, položka "Globální nastavení" sa nachází globální nastavení, které se aplikuje na všechna API napojení.

Pole " Počet neúspěšných prihlášení pro udělení BAN " umožnuje nastavit počet neúspešných pokusů o přístup k API. Pokud IP adresa dosáhne nastavený počet neúspešných pokusů, systém automaticky udělí této IP adrese BAN. Pokud nechcete, aby docházelo k automatickému BANu nastavte toto pole na hodnotu  "0".

 

4. Seznam BANů

V administráci eshopu / nastavení / API / pravé menu, položka "Seznam banů" sa nachází seznam veškerých banů, které systém eviduje v rámci API. V tomto seznamu je možné přidat BAN na libovolnou IP adresu nebo naopak BAN zrušit.