Creditas API funguje na principu bezpečného online propojení bankovního účtu s účetním programem či jiným systémem. Pro jeho využití nejdříve vytvořte bezpečnostní klíč v internetovém bankovnictví a nastavte mu konkrétní typ oprávnění (odkaz na Typy oprávnění). Následně předejte klíč kompetentní osobě a vložte jej do konkrétního programu, kde jej budete využívat.

Autorizovat bezpečnostní klíč v internetovém bankovnictví může majitel platebního účtu či oprávněná osoba. Počet bezpečnostních klíčů k jednomu účtu není omezen.

Creditas API podporuje OpenAPI standard stanovený Českou bankovní asociací. Bezpečnostní klíč tak proto můžete napojit do programu či systému, který OpenAPI podporuje.

Záleží na konkrétním softwaru, na cenových podmínkách a verzi, které máte nastaveny. Může být potřebné nejdříve zajistit OpenAPI modul nebo systém individuálně nastavit. Prvním krokem na vaší straně je předání technické dokumentace na IT oddělení či technickou podporu konkrétního softwaru, který používáte, a následně využití API konzultovat. V případě nejasností se nám ozvěte na e-mail [email protected], kde můžeme individuálně probrat vaše technické řešení.

Hromadný import platebních příkazů podporuje stejné formáty, jaké umožňuje internetové bankovnictví Banky CREDITAS. Domácí příkazy tak lze importovat ve formátech ABO a CSV. Zahraniční hromadné importy pak ve formátech XML nebo MT101. Export transakční historie se dělá ve formátech PDF, XML nebo CSV, výpisy z účtu pak ve formátech PDF nebo ABO.

Služba je přístupná na internetu přes šifrovanou komunikaci pomocí bezpečných protokolů. Každá služba má specifické URL a všechny jsou vystaveny metodou POST. Data na vstupu a výstupu volání jsou přenášená ve formátu JSON v těle zprávy. Pro využití jednotlivých služeb je při odeslání dotazu nutné v http hlavičce vždy uvést platný klíč v parametru „Authorization-Bearer“.