Utvecklare

Skapa en API-nyckel, exportera credentials.json och gör ditt första dekrypterade anrop på några minuter.

API-nycklar

Skapa din API-nyckel

Logga in för att skapa en API-nyckel och exportera ditt credentials-paket, välj sedan ett språk ovan för att göra ditt första anrop.

Autentisera med din nyckel

Skicka nyckeln i X-Api-Key-headern. Den ger samma åtkomst som du själv har till dina data.

bash

curl -H "X-Api-Key: $OBIO_API_KEY" http://localhost:39541/api/accounts
Använd SDK:et

Paket: @open-banking-io/client

npm
1

Installera

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

bash

npm install @open-banking-io/client
2

Anslut & anropa

Peka klienten mot din credentials.json — varje förfrågan autentiseras och varje svar dekrypteras 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.

Deploya till Kubernetes
1

Skapa din Secret

Nyckeln credentials.json= döper om din daterade nedladdning till ett rent filnamn inne i klustret.

bash

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

Montera det i en Deployment

Montera din Secret skrivskyddad och läs in den i din kod, t.ex. 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