Nastavení API konektorů

Update 10.01.2026

ČSOB API konektor

Zprovoznění služby ČSOB Business Connector

Kroky ke zprovoznění služby jsou tyto:

povolení služby ČSOB Business Connector u smlouvy o využívání služby CEB,
získání certifikátu od certifikační autority nebo přímo od banky,
registrace certifikátu pro použití ve službě ČSOB Business Connector v portálu,
konfigurace služby ČSOB Business Connector v portálu,
nastavení klientské aplikace v Business Central

Povolení služby ČSOB Business Connector u smlouvy o využívání služby CEB Zakázání, resp. povolení, služby ČSOB Business Connector je možné provést v portálu nebo pobočce banky

Získání certifikátu

Služba ČSOB Business Connector umožňuje používat certifikáty vydané certifikačními autoritami I. Certifikační autorita a PostSignum. Pro použití ve službě ČSOB Business Connector jsou vhodné pouze takzvané Serverové komerční certifikáty, které musí umožňovat takzvanou Klientskou autentizaci.

Certifikát lze získat také přímo od banky, což lze provést v zásadě 2 způsoby, buď

prostředky Windows (např. s pomocí IT pracovníka)
- ruční vytvoření žádosti o certifikát v klientském počítači (např. pomocí nástroje Windows certmgr.msc),
- podání žádosti o certifikát a vydání certifikátu (CEB -> Business Connector -> Požádat o certifikát a následně stažení certifikát volbou Stáhnout)
- instalace vydaného certifikátu v klientském počítači (např. pomocí nástroje Windows certmgr.msc)
nebo za pomoci aplikace ČSOB Business Connector(získání komunikačního certifikátu je popsáno v příručce csob-business-connector-implementacni-prirurucka.pdf). Jedná se o
- instalaci aplikace ČSOB Business Connector na počítač (kapitola 2),
- získání komunikačního certifikátu (kapitola 3).

Tip

Aplikace ČSOB Business Connector nebude pro běžnou práci využívána. Doporučujeme v ní ale nastavit upozornění na vypršení certifikátu (viz příručka v kapitole Obnova komunikačního certifikátu).

Registrace certifikátu

V případě certifikátu od banky (viz výše) je automaticky registrován.

Konfigurace služby ČSOB Business Connector v portálu V portálu je nutné povolit požadované operace, které bude klient pomocí ČSOB Business Connectoru využívat. V našem případě se jedná o Stahování výpisů pro konkrétní účty a Odesílání podepsaných souborů platebních příkazů pro konkrétní účty.

Nastavení klientské aplikace v Business Central

Pro nastavení Business Central je třeba stáhnout komunikační certifikát ve formátu pfx:

Stiskněte klávesy Windows + R a do otevřeného okénka napište certmgr.msc a stiskněte OK.
V nástroji certmgr rozbalte po levé straně Osobní a v seznamu nalezněte řádek certifikátu. Bude mít vydavatele CEB Business Connector CA a jméno subjektu, které jste zvolili.
Stiskněte na certifikátu pravé tlačítko myši a v kontextovém menu vyberte Všechny úkoly a Exportovat…
V průvodci exportem certifikátu vyberte Ano, exportovat privátní klíč a následně proveďte export do souboru PKCS #12 s koncovkou .pfx. Zadané heslo budete potřebovat v dalším kroku.

Dalším krokem je nastavení přístupu v Business Central:

Vyberte ikonu , zadejte Klienti ČSOB CEB a poté vyberte související odkaz.
Zadejte "ČSOB" v poli Kód na novém řádku.
Do pole Popis zadejte např. „ČSOB API“
V poli API prostředí ponechte hodnotu „Produkční“.
V poli Číslo smlouvy zadejte hodnotu ze smlouvy o přístupu k API, kterou jste s bankou podepsali.
V poli Dostupný pro ponechte hodnotu „Společnost“ pro nastavení společného přístupu pro všechny oprávněné uživatele modulu.
Spusťte akci Nahrát certifikát, vyberte soubor s certifikátem ve formátu pfx.
Zadejte heslo k certifikátu.

Tip

Chcete-li přístup určovat podle přihlášení uživatele, musí si každý uživatel sám provést výše uvedené nastavení Klienta ČSOB CEB. V poli Dostupný pro vybere hodnotu „Uživatel“.

Warning

Volbu Povolit protokol aktivity použijte pouze v odůvodněných případech po omezenou dobu, neboť v protokolu jsou obsažena citlivá data a mohou se k nim dostat i uživatelé, kteří by je vidět neměli.

Specifické parametry pro ČSOB API konektor Následující parametry je třeba doplnit do Rozšířeného nastavení v případě, že chcete používat ČSOB API konektor pro import bankovních výpisů:

Vyberte ikonu , zadejte Nastavení exportu/importu banky a poté vyberte související odkaz.
Přejděte na vybraný řádek typu Import.
Spusťte akci Rozšířené nastavení.
V poli Poskytovatel bankovních výpisů vyberte hodnotu „ČSOB CEN Connector“.
V poli Kód klienta ČSOB CEB vyberte kód klienta definovaný v předchozím kapitole.
V poli Formát souboru ČSOB CEB vyberte volbu GPC reprezentující formát ABO.
V poli Kódování obsahu doplňte hodnotu – viz kap. Nastavení kódování pro import
V poli ID procedury zpracování zkontrolujte, že se doplnila hodnota 52057431 (Bank Stmt.Imp.-ABO Acb).

Následující parametry je třeba doplnit do Rozšířeného nastavení v případě, že chcete používat ČSOB API konektor pro export platebních příkazů:

Vyberte ikonu , zadejte Nastavení exportu/importu banky a poté vyberte související odkaz.
Přejděte na vybraný řádek typu Export.
Spusťte akci Rozšířené nastavení.
V poli Poskytovatel bankovních výpisů vyberte hodnotu „ČSOB CEN Connector“.
V poli Kód klienta ČSOB CEB vyberte kód klienta definovaný v předchozím kapitole.
V poli Formát souboru ČSOB CEB vyberte volbu KPC reprezentující formát ABO.
V poli ID procedury zpracování zkontrolujte, že se doplnila hodnota 52057438 (Paym.Order Export-ABO acb).

KB API konektor

Zprovoznění API Business suite služby

Pro využití služby API Business suite od Komerční banky musíte mít aktivovánu vybranou aplikaci internetového bankovnictví (Moje Banka Business, or Profibanka, or Mobilní banka Business).

Základní kroky pro zprovoznění API rozhraní jsou:

Firma si aktivuje v KB službu API Business Suite.
Firma zažádá u firmy Aricoma o Autorizační klíč, který bude vygenerován speciálně pro ni a díky němuž Aricoma zaregistruje KB API konektor v KB.
Firma nastaví modul v Business Central.
Firma udělí souhlas Business Central aplikaci ke se stahováním dat z KB a vybere bankovní účty, ke kterým bude mít Business Central přístup.

Získání Autorizačního klíče

Kontaktujte nás e-mailem na adrese bc_sales@aricoma.com. Stačí nám pouze jméno vaší firmy, v odpovědi vám zašleme Autorizační klíč. Tento je určen pouze pro potřeby vaší firmy a nesmí být používán nikým jiným.

Nastavení modulu v BC

Dalším krokem je nastavení přístupu v Business Central:

Vyberte ikonu , zadejte Klienti KB API a poté vyberte související odkaz.
Na stránce Klienti KB API zadejte „KB“ v poli Kód na novém řádku.
Do pole Popis zadejte např. „KB API“.
V poli API ponechte hodnotu „Produkční prostředí“.
V poli Autorizační klíč zadejte hodnotu, kterou jste obdrželi od Aricoma (viz předchozí odstavec).
Spusťe akci Autorizovat klienta, úspěch se projeví změnou přepnutím příznaku Klient je autorizovaný.

Warning

Udělení souhlasu

Na stránce Klienti KB API spusťte akci Autorizovat klienta
V automaticky otevřeném novém okně se objeví dialog banky, kde po přihlášení budete vyzváni k udělení souhlasu s použitím aplikace „Aricoma KB konektor“.
Ihned poté se objeví další výzva k přihlášení, po kterém vyberete bankovní účty, ke který má mít „Aricoma KB konektor“ přístup.

Erste API konektor

Zprovoznění služby Premium API

Pro zprovoznění API rozhraní je třeba

registrovat se na Erste Developer Portal (EDP),
na portálu vytvořit aplikaci,
požádat o přístup aplikace do produkčního prostředí a
nastavit modul v Business Central.

Registrace firmy v EDP

Při registraci doplníte požadované informace o vaší firmě, viz Postup registrace.

Vytvoření aplikace

V organizaci je třeba vytvořit novou "aplikaci" a propojit ji s bankou, viz postup. Doplňte následující parametry:

Vlastnost	Hodnota
Název aplikace	Aricoma Erste API Connector
Typ	Web
Platforma	Server
Jazyk	Jiný
Použití aplikace	Final API Consumer

Banky:

Česká spořitelna, a.s.

Připojení k API:

vyberte Premium - Accounts API a Premium - Payments API
povolte OAuth2

Žádost o přístup do produkčního prostředí

Je-li vše správně nastaveno (a potvrzeno bankou), na záložce Produkce lze vygenerovat přístupové údaje.

Nastavení modulu v BC

Dalším krokem je nastavení přístupu v Business Central:

Vyberte ikonu , zadejte Klienti Erste API a poté vyberte související odkaz.
Na stránce Klienti Erste API zadejte „ČS“ v poli Kód na novém řádku.
Do pole Popis zadejte např. „ČS API“.
Do pole Připojená banka vyberte „Česká spořitelna“.
V poli API prostředí vyberte hodnotu „Produkční prostředí“.
V poli API klíč zadejte hodnotu získanou z portálu (viz předchozí odstavec).
V poli ID klienta zadejte hodnotu získanou z portálu (viz předchozí odstavec).
V poli Tajný klíč klienta zadejte hodnotu získanou z portálu (viz předchozí odstavec).
V poli Platnost autorizace můžete změnit platnost autorizace na dobu kratší než je maximální povolená doba, a to 180 dní.
Spusťe akci Autorizovat klienta, úspěch se projeví změnou přepnutím příznaku Klient je autorizovaný.

Warning

Raiffeisen API konektor

Zprovoznění služby RB Premium API

Pro zprovoznění API rozhraní je třeba

vytvořit klientský certifikát a
nastavit modul v Business Central.

Vytvoření klientského certifikátu

V aplikaci bankovnictví v části Nastavení (ikonka ozubeného kola) provedete vytvoření certifikátu takto:

V levém menu poté vyberte Správa certifikátů > Nový certifikát
Na formuláři Vygenerování certifikátu zadejte:
- Název certifikátu - informační pro vás (např. "Business Central API")
- Heslo k certifikátu - zadejte silné heslo a poznamenejte si ho (budete potřeba pro další nastavení v Business Central)
- Heslo znovu - opakujte zadání hesla
- Výběr účtů - vyberte účty, které chcete s Business Cental propojit pomocí API; u každého vyberte, zda chcete umožnit pouze stahovat Transakční historii nebo i odesílat Hromadné platby.
- potvrďte souhlas s podmínkami užívání certifikátu a zvolte akci Pokračovat
Na formuláři Vygenerování certifikátu kliknutím na tlačítko Podepsat spusťte proces schvalování přes mobilní aplikaci.
Po schválení na stránce Certifikát byl vygenerován spusťte akci Stáhnout certifikát.

Nastavení klientské aplikace v Business Central

Vyberte ikonu , zadejte Klienti Raiffeisen API a poté vyberte související odkaz.
Na stránce Klienti Raiffeisen API zadejte „RB“ v poli Kód na novém řádku.
Do pole Popis zadejte např. „Raiffeisen API“.
V poli API prostředí ponechte hodnotu „Produkční“.
V poli Dostupný pro ponechte hodnotu „Společnost“, aby byl nastaven společný přístup pro všechny oprávněné uživatele modulu.
Spusťte akci Nahrát certifikát, vyberte soubor s certifikátem ve formátu pfx.
Zadejte heslo k certifikátu.

Tip

Chcete-li přístup určovat podle přihlášení uživatele, musí si každý uživatel sám provést výše uvedené nastavení Klienta Raiffeisen. V poli Dostupný pro vybere hodnotu „Uživatel“.

Warning

Specifické parametry pro Raiffeisen API konektor Následující parametry je třeba doplnit do Rozšířeného nastavení v případě, že chcete používat Raiffeisen API konektor pro import bankovních výpisů:

Vyberte ikonu , zadejte Nastavení exportu/importu banky a poté vyberte související odkaz.
Přejděte na vybraný řádek typu Import.
Spusťte akci Rozšířené nastavení.
V poli Poskytovatel bankovních výpisů vyberte hodnotu „Raiffeisen Bank API“.
V poli Kód klienta Raiffeisen API vyberte kód klienta definovaný v předchozím kapitole.
V poli Formát výpisů Raiffeisen vyberte volbu GPC reprezentující formát ABO.
V poli ID procedury zpracování zkontrolujte, že se doplnila hodnota 52057627 (RB Bank Stmt.Imp.-MT940 Acb).

Následující parametry je třeba doplnit do Rozšířeného nastavení v případě, že chcete používat ČSOB API konektor pro export platebních příkazů:

Vyberte ikonu , zadejte Nastavení exportu/importu banky a poté vyberte související odkaz.
Přejděte na vybraný řádek typu Export.
Spusťte akci Rozšířené nastavení.
V poli Poskytovatel bankovních výpisů vyberte hodnotu „Raiffeisen Bank API“.
V poli Kód klienta Raiffeisen API vyberte kód klienta definovaný v předchozím kapitole.
V poli Formát plateb Raiffeisen vyberte volbu ABO-KPC reprezentující formát ABO.
V poli ID procedury zpracování zkontrolujte, že se doplnila hodnota 52057625 (RB Paym.Order Export-ABO Acb).

Import jednotlivých transakcí

Pokud bankovní API podporuje možnost stahování jednotlivých platbách, je na kartě Rozšířeného nastavení importu výpisů v poli definující formát výpisů volba "Jednotlivé transakce". Pokud ji zvolíte, nastaví se správná procedura zpracování obdobně jako při výběru formátu pro denní výpisy.

Používáte-li automatizaci tvorby výpisů pomocí importu z Centrálního zásobníku, je třeba navíc nastavit příznak Importovat jednotlivé transakce na kartách všech požadovaných bankovních účtů. Tím lze např. docílit situace, že pro korunový účet jsou importovány jednotlivé transakce a pro ostatní měny téhož účtu jsou importovány bankovní výpisy.

Note

Pole Počet dní transakční historie na kartě klienta API je vztaženo k transakci, kterou může být jena platba ale i třeba měsíční výpis. Pokud kombinujete výrazně odlišné přístupy pro stahování výpisů v rámci jednoho API (např. některé účty 1 týdně a jiné po jednotlivých transakcích), doporučujeme vytvořit samostatné API klienty s tím, že u stahování jednotlivých plateb ponecháte Počet dní transakční historie na hodnotě 5, ale pro týdenní periodu zpracování výpisů nastavíte hodnotu např. 10.