Sviluppatori

Crea un'API key, esporta credentials.json ed effettua la tua prima chiamata decifrata in pochi minuti.

API key

Crea la tua API key

Accedi per creare un'API key ed esportare il tuo bundle di credenziali, poi scegli un linguaggio qui sopra per effettuare la tua prima chiamata.

Autenticati con la tua chiave

Invia la chiave nell'header X-Api-Key. Concede lo stesso accesso che hai tu ai tuoi dati.

bash

curl -H "X-Api-Key: $OBIO_API_KEY" http://localhost:39541/api/accounts
Usa l'SDK

Pacchetto: @open-banking-io/client

npm
1

Installa

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

bash

npm install @open-banking-io/client
2

Connetti e chiama

Punta il client al tuo credentials.json — ogni richiesta è autenticata e ogni risposta è decifrata in-process.

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

Metodi

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.

Fai il deploy su Kubernetes
1

Crea il Secret

La chiave credentials.json= rinomina il tuo download datato in un nome di file pulito all'interno del cluster.

bash

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

Montalo in un Deployment

Monta il Secret in sola lettura e caricalo nel tuo codice, es. 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