Ontwikkelaars

Maak een API-sleutel aan, exporteer credentials.json en doe je eerste ontsleutelde aanroep binnen enkele minuten.

API-sleutels

Maak je API-sleutel aan

Log in om een API-sleutel aan te maken en je credentials-bundel te exporteren, kies daarna hierboven een taal om je eerste aanroep te doen.

Authenticeer met je sleutel

Stuur de sleutel in de X-Api-Key-header. Deze geeft dezelfde toegang die je zelf tot je eigen gegevens hebt.

bash

curl -H "X-Api-Key: $OBIO_API_KEY" http://localhost:39541/api/accounts
Gebruik de SDK

Pakket: @open-banking-io/client

npm
1

Installeren

Requires Node ≥ 20 (built-in WebCrypto + fetch, no runtime deps).

bash

npm install @open-banking-io/client
2

Verbinden & aanroepen

Wijs de client naar je credentials.json — elke aanvraag wordt geauthenticeerd en elk antwoord wordt in-process ontsleuteld.

index.ts

import { OpenBankingClient } from "@open-banking-io/client";

// Load the credentials.json you exported from the app (API key + private key).
const client = OpenBankingClient.fromCredentials("credentials.json");

for (const account of await client.getAccounts()) {
  const booked = account.balances.find((b) => b.type === "ITBD");
  console.log(`${account.displayName ?? account.ownerName} ${account.iban}: ${booked?.amount} ${account.currency}`);

  const page = await client.getTransactions(account.id, { limit: 50 });
  for (const t of page.items) {
    console.log(`  ${t.bookingDate}  ${t.creditorName ?? t.debtorName}  ${t.amount} ${t.currency}`);
  }
}
3

Methoden

getAccounts()

List your accounts with decrypted balances.

getTransactions(accountId, …)

Page an account's transactions (date range, limit, offset).

getConnections()

List your connected banks.

sync(accountId)

Refresh one account from the bank (decrypts the session uid locally).

syncAll()

Refresh every account that has an active session.

Deploy naar Kubernetes
1

Maak de Secret aan

De sleutel credentials.json= hernoemt je gedateerde download naar een schone bestandsnaam binnen het cluster.

bash

kubectl create secret generic obio-credentials \
  --from-file=credentials.json=./open-banking.io-credentials-2026-07-18.json
2

Mount hem in een Deployment

Mount de Secret alleen-lezen en laad hem in je code, bijv. fromCredentials("/etc/obio/credentials.json").

deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: reporting-job
spec:
  replicas: 1
  selector:
    matchLabels: { app: reporting-job }
  template:
    metadata:
      labels: { app: reporting-job }
    spec:
      containers:
        - name: app
          image: ghcr.io/acme/reporting:latest
          env:
            - name: OBIO_CREDENTIALS
              value: /etc/obio/credentials.json
          volumeMounts:
            - name: obio-credentials
              mountPath: /etc/obio
              readOnly: true
      volumes:
        - name: obio-credentials
          secret:
            secretName: obio-credentials