Entwickler

Erstellen Sie einen API key, exportieren Sie credentials.json und führen Sie in wenigen Minuten Ihren ersten entschlüsselten Aufruf aus.

API keys

API key erstellen

Melden Sie sich an, um einen API key zu erstellen und Ihr Credentials-Bundle zu exportieren. Wählen Sie anschließend oben eine Sprache und führen Sie Ihren ersten Aufruf aus.

Mit Ihrem Schlüssel authentifizieren

Senden Sie den Schlüssel im X-Api-Key-Header. Er gewährt denselben Zugriff, den Sie selbst auf Ihre Daten haben.

bash

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

Paket: @open-banking-io/client

npm
1

Installieren

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

bash

npm install @open-banking-io/client
2

Verbinden & aufrufen

Richten Sie den Client auf Ihre credentials.json – jede Anfrage wird authentifiziert und jede Antwort im Prozess entschlüsselt.

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.

Auf Kubernetes deployen
1

Das Secret erstellen

Der Schlüssel credentials.json= benennt Ihren datierten Download innerhalb des Clusters in einen sauberen Dateinamen um.

bash

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

In einem Deployment einbinden

Binden Sie das Secret schreibgeschützt ein und laden Sie es in Ihrem Code, z. B. 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