Utviklere

Opprett en API-nøkkel, eksporter credentials.json, og kjør ditt første dekrypterte kall på få minutter.

API-nøkler

Opprett API-nøkkelen din

Logg inn for å opprette en API-nøkkel og eksportere credentials-pakken din, og velg deretter et språk ovenfor for å kjøre ditt første kall.

Autentiser med nøkkelen din

Send nøkkelen i X-Api-Key-headeren. Den gir samme tilgang som du selv har til dine egne data.

bash

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

Pakke: @open-banking-io/client

npm
1

Installer

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

bash

npm install @open-banking-io/client
2

Koble til & kall

Pek klienten mot din credentials.json — hvert kall autentiseres, og hvert svar dekrypteres i prosessen.

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

Opprett Secret-en

Nøkkelen credentials.json= gir den daterte nedlastingen din et rent filnavn inne i clusteret.

bash

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

Monter den i et Deployment

Monter Secret-en skrivebeskyttet og last den inn i koden din, f.eks. 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