Programadores

Cria uma chave de API, exporta o credentials.json e faz a tua primeira chamada desencriptada em minutos.

Chaves de API

Cria a tua chave de API

Inicia sessão para criar uma chave de API e exportar o teu pacote de credenciais, depois escolhe uma linguagem acima para fazer a tua primeira chamada.

Autentica-te com a tua chave

Envia a chave no cabeçalho X-Api-Key. Concede o mesmo acesso que tens aos teus próprios dados.

bash

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

Pacote: @open-banking-io/client

npm
1

Instalar

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

bash

npm install @open-banking-io/client
2

Ligar e chamar

Aponta o cliente para o teu credentials.json — cada pedido é autenticado e cada resposta é desencriptada no processo.

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.

Faz deploy no Kubernetes
1

Cria o Secret

A chave credentials.json= muda o nome do teu download datado para um nome de ficheiro limpo dentro do cluster.

bash

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

Monta-o num Deployment

Monta o Secret apenas de leitura e carrega-o no teu código, por exemplo 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