Udviklere

Opret en API-nøgle, eksportér credentials.json og kør dit første dekrypterede kald på få minutter.

API-nøgler

Opret din API-nøgle

Log ind for at oprette en API-nøgle og eksportere din credentials-pakke. Vælg derefter et sprog ovenfor og kør dit første kald.

Godkend med din nøgle

Send nøglen i X-Api-Key-headeren. Den giver samme adgang, som du selv har til dine data.

bash

curl -H "X-Api-Key: $OBIO_API_KEY" http://localhost:36179/api/accounts
Brug SDK'et

Pakke: @open-banking-io/client

npm
1

Installér

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

bash

npm install @open-banking-io/client
2

Forbind & kald

Peg klienten på din credentials.json — hvert kald godkendes, og hvert svar dekrypteres i processen.

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

Metoder

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 til Kubernetes
1

Opret din Secret

Nøglen credentials.json= omdøber din daterede download til et rent filnavn inde i clusteret.

bash

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

Mount den i et Deployment

Mount din Secret skrivebeskyttet og indlæs den i din kode, fx 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