Deweloperzy

Utwórz klucz API, wyeksportuj credentials.json i wykonaj pierwsze odszyfrowane wywołanie w kilka minut.

Klucze API

Utwórz swój klucz API

Zaloguj się, aby utworzyć klucz API i wyeksportować pakiet danych uwierzytelniających, a następnie wybierz język powyżej, aby wykonać pierwsze wywołanie.

Uwierzytelnij się swoim kluczem

Wyślij klucz w nagłówku X-Api-Key. Daje on taki sam dostęp, jaki masz do własnych danych.

bash

curl -H "X-Api-Key: $OBIO_API_KEY" http://localhost:39541/api/accounts
Użyj SDK

Pakiet: @open-banking-io/client

npm
1

Zainstaluj

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

bash

npm install @open-banking-io/client
2

Połącz i wywołaj

Wskaż klientowi swój plik credentials.json — każde żądanie jest uwierzytelnione, a każda odpowiedź odszyfrowana w procesie.

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

Metody

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.

Wdróż na Kubernetes
1

Utwórz Secret

Klucz credentials.json= zmienia nazwę Twojego datowanego pliku na czystą nazwę wewnątrz klastra.

bash

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

Zamontuj go w Deployment

Zamontuj Secret w trybie tylko do odczytu i wczytaj go w kodzie, np. 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