Klanthulp

De API gebruiken

Hoe goedgekeurde technische clients authenticeren en werken.

Doelgroep

Voor goedgekeurde integrators en technische operators.

De integratie-API is ontworpen voor goedgekeurde externe klanten die machinetoegang nodig hebben tot MZ Bank accountgegevens en workflows.
Het openbare basispad is /api/v1/integrations/*.
API-toegang staat los van Discord inloggen en de normale klantportalsessie.

API-sleutels zijn gebonden aan één actief, geverifieerd MZ Bank klantprofiel.
Een MZ Bank beheerder maakt de sleutel en kiest de toegestane bereiken.
Webhook-abonnementen worden ook door een beheerder aangemaakt en gebruiken een afzonderlijk ondertekeningsgeheim.

Verzend de API-sleutel als een dragertoken in de header Authorization.
Elke sleutel heeft een beperkte reikwijdte. accounts:read omvat bijvoorbeeld accountweergaven, terwijl transfers:write het maken van overboekingen mogelijk maakt.
Sleutels kunnen worden gerouleerd of ingetrokken zonder dat de normale website of bottoegang van de klant wordt gewijzigd.

Klanten kunnen zichtbare rekeningen, saldi, transactiegeschiedenis, afschriften, begunstigden, meldingsvoorkeuren, applicaties en bedrijfsfamilieweergaven lezen als de juiste scopes aanwezig zijn.
Accountreacties zijn zich bewust van subaccounts en bevatten waar relevant root-familie-ID's.
De reacties van bedrijven en families omvatten onder meer onderliggende subaccounts, uiteindelijk gerechtigden, actieve toegangsrechten en mogelijkheden voor bellers.

De API ondersteunt door de klant bediende verzoeken zoals overboekingen, het aanmaken van subaccounts, accountaanvragen, begunstigdebeheer, updates van kennisgevingsvoorkeuren, opnameverzoeken en stortingsverzoeken.
Routes voor het verplaatsen van geld moeten nog steeds voldoen aan dezelfde autorisatie-, tarieflimiet- en grootboekregels die worden afgedwongen door de bot en de portal.
Schrijfaanvragen moeten idempotency-sleutels gebruiken waar de route deze vereist, zodat veilige nieuwe pogingen geen dubbele activiteit veroorzaken.

Bij routes tussen bedrijven en gezinnen worden dezelfde regels voor eigendom en gedelegeerde toegang gebruikt als voor de portal.
Subaccountbewuste reacties omvatten zowel de leaf-account-ID als de root-account-ID van het bedrijfsfamilie.
Gedelegeerde operators kunnen alleen de accounts en acties gebruiken die zijn toegestaan door hun huidige rol en limieten.

Webhook-abonnementen kunnen levenscyclusgebeurtenissen voor stortingen, opnames en overdrachten ontvangen.
Overdrachtswebhooks worden afzonderlijk verzonden voor de uitgaande en inkomende accountzijde, zodat consumenten met subaccounts en gezinsbewuste consumenten elke zijde correct kunnen verwerken.
Elke webhook is ondertekend met x-mzb-signature-256 en consumenten moeten de handtekening verifiëren aan de hand van de exacte onbewerkte tekst.

Afschriftenlijst- en afschriftexportroutes bieden dezelfde gepubliceerde afschriftgeschiedenis waartoe de klant toegang heeft via het Statement Center.
Meldingsroutes leggen zowel opgeslagen voorkeuren als recente bezorgresultaten bloot.
API-activiteit moet aansluiten bij de portalstatus, verklaringen en webhookgebeurtenissen voor dezelfde klant of bedrijfsfamilie.

Vraag een MZ Bank beheerder om een scoped testsleutel uit te geven met alleen de lees- en schrijfmogelijkheden die uw klant daadwerkelijk nodig heeft.
Valideer de verwerking van de webhook op basis van een wegwerpbaar vastleggingseindpunt voordat u gebeurtenissen naar een productie-callback-URL verzendt.
Als u de uitgebreide operatorreferentie voor eindpunten, scopes en probleemoplossing nodig heeft, vraag dan een beheerder om de interne integratiedocumentatie.