Kehittäjät

Luo API key, vie credentials.json ja tee ensimmäinen salauksesta puretun datan kutsusi minuuteissa.

API-avaimet

Luo API keysi

Kirjaudu sisään luodaksesi API keyn ja viedäksesi tunnistetietopakettisi, valitse sitten kieli yltä tehdäksesi ensimmäisen kutsusi.

Todenna avaimellasi

Lähetä avain X-Api-Key-otsakkeessa. Se antaa saman pääsyn, joka sinulla on omiin tietoihisi.

bash

curl -H "X-Api-Key: $OBIO_API_KEY" http://localhost:39541/api/accounts
Käytä SDK:ta

Paketti: @open-banking-io/client

npm
1

Asenna

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

bash

npm install @open-banking-io/client
2

Yhdistä & kutsu

Osoita client credentials.json-tiedostoosi — jokainen pyyntö todennetaan ja jokaisen vastauksen salaus puretaan prosessissa.

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

Metodit

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.

Deployaa Kubernetesiin
1

Luo Secret

credentials.json= -avain nimeää päivätyn latauksesi siistiksi tiedostonimeksi klusterin sisällä.

bash

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

Liitä se Deploymentiin

Liitä Secret vain luku -tilassa ja lataa se koodissasi, esim. 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