Zakaznicka napoveda

Používání API

Jak schválení techničtí klienti používají API.

Komu je navod urcen

Pro schválené integrátory a technické operátory.

Integrační rozhraní API je navrženo pro schválené externí klienty, kteří potřebují strojový přístup k datům a pracovním postupům účtu MZ Bank.
Veřejná základní cesta je /api/v1/integrations/*.
Přístup k rozhraní API je oddělený od přihlášení Discord a běžné relace zákaznického portálu.

Klíče API jsou vázány na jeden aktivní, ověřený MZ Bank zákaznický profil.
Správce MZ Bank vytvoří klíč a vybere povolené rozsahy.
Předplatná webhooku také vytváří správce a používají samostatné podpisové tajemství.

Odešlete klíč API jako token nosiče v záhlaví Authorization.
Každý klíč má omezený rozsah. Například accounts:read pokrývá zobrazení účtu, zatímco transfers:write umožňuje vytvoření převodu.
Klíče lze otáčet nebo zrušit, aniž by se měnily běžné webové stránky zákazníka nebo přístup robota.

Klienti mohou číst viditelné účty, zůstatky, historii transakcí, výpisy, příjemce, předvolby oznámení, aplikace a rodinné pohledy, pokud jsou k dispozici správné rozsahy.
Odpovědi účtu berou na vědomí podúčty a v případě potřeby zahrnují identifikátory kořenové rodiny.
Mezi firemní a rodinné odpovědi patří podúčty dětí, skutečné vlastníky, granty aktivního přístupu a možnosti volajícího.

Rozhraní API podporuje požadavky zákazníka, jako jsou převody, vytvoření podúčtu, aplikace účtů, správa příjemců, aktualizace preferencí oznámení, žádosti o výběr a žádosti o vklad.
Trasy pohybu peněz musí stále splňovat stejná pravidla autorizace, rychlostního limitu a účetní knihy vynucená robotem a portálem.
Požadavky na zápis by měly používat klíče idempotence všude tam, kde to trasa vyžaduje, aby bezpečné opakování nevytvářelo duplicitní aktivitu.

Trasy obchodní rodiny používají stejná pravidla vlastnictví a delegovaného přístupu jako portál.
Odpovědi s vědomím podúčtu zahrnují ID koncového účtu i ID kořenového firemního účtu.
Delegovaní operátoři mohou používat pouze účty a akce povolené jejich aktuální rolí a limity.

Předplatná webhooku mohou přijímat události životního cyklu vkladů, výběrů a převodů.
Přenosové webhooky jsou vydávány odděleně pro odchozí a příchozí stranu účtu, takže spotřebitelé s podúčtem a s ohledem na rodinu mohou každou stranu zpracovat správně.
Každý webhook je podepsán kódem x-mzb-signature-256 a spotřebitelé by měli podpis ověřit podle přesného surového těla.

Trasy výpisu-seznamu a výpisu-exportu poskytují stejnou publikovanou historii výpisů, ke které má zákazník přístup prostřednictvím Centrum výpisů.
Trasy oznámení odhalují uložené preference i nedávné výsledky doručení.
Aktivita API by měla být v souladu se stavem portálu, prohlášeními a událostmi webhooku pro stejného zákazníka nebo obchodní rodinu.

Požádejte administrátora MZ Bank, aby vydal testovací klíč s rozsahem pouze se schopnostmi čtení a zápisu, které váš klient skutečně potřebuje.
Před odesláním událostí na produkční adresu URL zpětného volání ověřte zpracování webhooku proti jednorázovému koncovému bodu zachycení.
Pokud potřebujete vyčerpávající referenci operátora pro koncové body, rozsahy a odstraňování problémů, požádejte správce o dokumentaci k interní integraci.