Public API – základy

Fidoo Public API propojí Fidoo s vašimi systémy: umí číst i spravovat karty, výdaje, uživatele, cesťáky, knihu jízd, číselníky a další oblasti. Tenhle článek shrnuje, co potřebujete k prvnímu volání; jednotlivá volání popisují navazující články podle oblastí aplikace.

Prostředí

Produkční API běží na adrese https://api.fidoo.com/v2/. Na stejné adrese najdete dokumentaci (Swagger) v angličtině, ve které si volání můžete rovnou vyzkoušet.

Pro testování vám zřídíme demo prostředí s API na adrese https://api-demo.fidoo.com/v2/. O zřízení požádejte na e-mailu info@fidoo.com.

Klíč z produkčního prostředí platí jen na produkční adrese a klíč z demo prostředí jen na demo adrese. Chybový stav 401 Unauthorized obvykle znamená právě záměnu prostředí.

API klíč

Každé volání posílá klíč v hlavičce X-Api-Key. Klíč vystavuje Hlavní správce ve Fidoo aplikaci a klíč si propůjčuje práva uživatele, na kterého je vystavený, proto některá volání nemusí fungovat, když uživatel potřebnou roli ztratí. Vytvoření a deaktivaci klíče popisuje Správa API klíčů. Generování a správa API klíčů není dostupná pro klienty s balíčkem Start.

Ověření klíče

GET /v2/status/user-info

Vrátí potvrzení, že klíč funguje, a informace o uživateli, na kterého je klíč vystavený.

Stránkování výpisů

Výpisy vracejí data po dávkách. Velikost dávky určuje parametr limit, výchozí hodnota je 100. Když odpověď vrátí "complete": false, pokračujte dalším voláním a do parametru offsetToken vložte hodnotu nextOffsetToken z předchozí odpovědi. Opakujte, dokud odpověď nevrátí "complete": true.

Formáty

Data a časy se posílají i vracejí ve formátu ISO 8601, například 2026-08-06T12:30:00Z. Měny se uvádějí ve formátu ISO 4217, například CZK. Sazba DPH (vatRate) se uvádí jako zlomek v rozmezí 0 až 1, sazbě 21 % tedy odpovídá hodnota 0.21.

Jak číst tabulky v referenci

• (povinné) za názvem parametru znamená, že volání bez něj neprojde.
• Hodnoty: vyjmenovává stavy, kterých parametr nabývá, ve tvaru hodnota = význam.
• Když popisuje podmínku, za které se vrací odlišná hodnota.
• Parametr s tečkou na začátku (· cardId) je vnořený do nejbližšího parametru nad ním bez tečky; dvě tečky znamenají druhou úroveň vnoření.

PSD2 API

PSD2 API je samostatné rozhraní pro licencované poskytovatele: potřebujete certifikát od První certifikační autority a licenci České národní banky. Běží na adrese https://psd2-api.fidoo.com/psd2-cobs/ a kompletní návod najdete na https://psd2.fidoo.com/.