Tatra banka API (SK)
Submodul Tatra banka API je možné aktivovat pouze v případě již aktivního modulu Fakturace.
Zjednodušeně se jedná o možnost automatizovaného stahování informací o platbách (avíz) z bankovního serveru Tatra banky (Slovensko) do systému ISPadmin a jejich následné automatické nebo ruční zpracování.
Důležité:
Po vytvoření aplikace a přidání API rozhraní, jsou přístupy a aplikace v režimu Sandbox (testovací režim) pro prvotní otestování komunikace s bankou. Po otestování je potřeba aplikaci přepnout do produkčního prostředí (ostrého provozu). Podrobnosti viz níže.
Postup pro zprovoznění
Pro korektní připojení na API Tatra banky (SK) – Premium API, je nutné splnit několik následujících kroků k získání přihlašovacích parametrů:
- Registraci a přihlášení na developer portálu Tatra banky – https://developer.tatrabanka.sk/
2. Vytvoření aplikace na developer portálu:
Vytvořit aplikaci je možné tlačítkem Pridať aplikáciu (
) v levém menu Aplikácie.
Důležité je vyplnit:
- Název aplikace
- Popis aplikace
- API – zvolit Premium API – Accounts v3.0.0 (přijmout podmínky)
- Callback/Redirect URL – https://[domena_admin nebo IP_adresa]/billing-bank-tatrabanka-settings/complete
- Scope – zadat PREMIUM_AIS
- Typ – zvolit Dôverné
- API Key / Client ID – zkopírovat do nastavení ISPA
- Shared secret / Client secret – zkopírovat do nastavení ISPA
- Premium API Usage – zvolit Final Consumer
- Webhook Enabled – zvolit No
Následně je možné formulář dole Uložit (
).
3. Nastavení ISPA:
V menu (Fakturace –> Nastavení –> Banka –> Tatra banka) je potřeba přidat získané informace z developer portálu (testovací režim).
4. Otestování komunikace:
Nyní je možné otestovat komunikaci s bankou v přehledu přidaných API účtů tlačítkem Udělit přístup (
).
Vyskočí tzv. consent screen banky, kde je možné zvolit testovací data a udělit přístup. Zvolit je možné z několika (pro test stačí např. Student).
Autorizace API pro získání přístupu k účtu (Premium API):
Doba platnosti (přístup ze strany Tatra banky) je 90 dnů. Po uplynutí této doby je potřeba udělit přístup (Fakturace –> Nastavení –> Banka –> Tatra banka) k účtu znovu.
Systém Vás na tento stav (blížící se vypršení doby platnosti) upozorní 10 dní před koncem (v dashboardu, v přehledu stažených plateb, emailem a systémovým upozorněním).
Notifikace (1x denně) se vygeneruje již 10 dní před vypršením doby platnosti přístupu a bude se generovat až do doby, než je problém vyřešen. Notifikace přijde všem uživatelům, kteří mají právo zobrazit stránku s nastavením (Fakturace –> Nastavení –> Banka –> Tatra banka).
Z upozornění (widgetu) v dashboardu je možné se prokliknout přímo do příslušné záložky pro obnovení nastavení přístupu tlačítkem Upravit (
).
DŮLEŽITÉ:
Akci Udělit přístup je nutné provést z nastaveného cíle (URL) v poli Callback/Redirect URL v developer portálu.
Pokud je ve zmíněném poli nastavena URL s doménovým jménem je nutné udělit přístup z ISPA, ke kterému přistoupíte přes doménové jméno (ne IP adresu). To stejné naopak – v případě nastavené IP adresy (v URL) v poli Callback/Redirect URL, je nutné udělit přístup z admina, ke kterému přistoupíte přes IP adresu.
V opačném případě dojde k zobrazení chybového okna (chyba – invalid_redirect_uri) viz obr. níže.
DŮLEŽITÉ:
Pro přepnutí aplikace do produkčního prostředí (použití vlastního bank. účtu), je nutné požádat Tatra banku o přístup. Pro udělení přístupu je potřebné zaslat žádost na developer@tatrabanka.sk, kde uvedete název organizace, název aplikace a API rozhraní (Premium API – Accounts), pro které žádáte přidělení produkčního plánu (viz WIKI Tatra banky – https://developer.tatrabanka.sk/apihub/#/wiki).
Přes tlačítko Udělit přístup () v (Fakturace –> Nastavení –> Banka –> Tatra banka) dojde k udělení přístupu vytvořené aplikaci (ISPadmin) v produkčním prostředí. Zobrazí se tzv. consent screen pro možnost zadat přihl. údaje, udělit souhlas (povolit přístup k bank. účtu).
V případě nejasností kontaktujte prosím podporu ISPadmin (support@ispadmin.eu).
Práva
Zobrazení záložky s nastavením Tatra banka je podmíněno nastavením práv pro tuto záložku konkrétním a kompetentním uživatelům.
V Nastavení -> Administrátoři -> Administrátoři povolit konkrétnímu uživateli/skupině práva pro záložku hlavního menu Fakturace / Nastavení / Banka / Tatra banka případně i pro zobrazení stažených plateb Fakturace / Banka / Tatra banka.
Stahování a párování plateb
Správa a přehled získaných avíz o provedených platbách je možná v (Fakturace -> Banka -> Tatra banka).
Stažené platby se budou automaticky stahovat a párovat pomocí nastavených pravidel v (Fakturace -> Nastavení -> Banka -> Pravidla). Je možné je i dopárovat ručně na více faktur, do kreditu apod.