Desarrolladores

Crea una API key, exporta credentials.json y realiza tu primera llamada descifrada en cuestión de minutos.

API keys

Crea tu API key

Inicia sesión para crear una API key y exportar tu paquete de credenciales; después elige un lenguaje arriba para realizar tu primera llamada.

Autentícate con tu clave

Envía la clave en la cabecera X-Api-Key. Concede el mismo acceso que tú tienes a tus propios datos.

bash

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

Paquete: @open-banking-io/client

npm
1

Instala

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

bash

npm install @open-banking-io/client
2

Conecta y llama

Apunta el cliente a tu credentials.json: cada solicitud se autentica y cada respuesta se descifra en el propio proceso.

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

Métodos

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.

Despliega en Kubernetes
1

Crea el Secret

La clave credentials.json= renombra tu descarga con fecha a un nombre de archivo limpio dentro del clúster.

bash

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

Móntalo en un Deployment

Monta el Secret en modo solo lectura y cárgalo en tu código, p. ej. 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