Autentizace

Externí integrace se přihlašuje API tokenem. Token vytvoříte v pokladně v Nastavení → API přístupy (modul 10223 API přístupy, postup v návodu API přístupy) nebo operacemi správy přístupů níže. Přístup patří uživateli, který ho vytvořil, a jeho firmě. Volání přes token mají stejná oprávnění jako tento uživatel.

Bearer token

Typ BEARER se posílá v hlavičce Authorization. V dokumentaci ho zastupuje neplatná ukázková hodnota:

Authorization: Bearer elp_live_example.example_secret

Celou hodnotu tokenu dostanete jen jednou, v poli plaintext při vytvoření nebo obnovení přístupu. Detail a výpis vracejí jen zkrácenou předponu tokenPrefix. Nový token platí standardně 12 měsíců, jinou platnost nastavíte datem nebo noExpiration: true.

URL token

Typ URL se předává parametrem api_token v adrese:

https://www.elpokladny.cz/api/v2/docs?api_token=example.example_secret

Hodí se tam, kde nejde nastavit hlavičku, například pro stahování exportu. Bearer a URL tokeny nejsou zaměnitelné. Adresu s tokenem chraňte jako heslo, protože se může uložit do historie prohlížeče nebo do logů.

IP omezení a platnost

Přístup může být omezený na jednotlivé IPv4 nebo IPv6 adresy či rozsahy CIDR. Pokud nemá povolené všechny adresy, volání z jiné adresy vrátí 403.

Token funguje, dokud nevyprší, není zneplatněný a jeho uživatel i firma jsou aktivní. Neplatný nebo neaktivní token vrátí 401. Přístupy firmy může spravovat kterýkoli uživatel této firmy s modulem 10223.

Chyby přihlášení

Chybějící nebo neplatný token vrací HTTP 401 s tělem {"status":"error","message":"Unauthorized"}. Volání z nepovolené IP adresy vrací HTTP 403 s tělem {"status":"error","message":"Forbidden"}. Další stavy popisují Chybové stavy.