Développeurs

Créez une clé API, exportez credentials.json et effectuez votre premier appel déchiffré en quelques minutes.

Clés API

Créez votre clé API

Connectez-vous pour créer une clé API et exporter votre lot d'identifiants, puis choisissez un langage ci-dessus pour effectuer votre premier appel.

Authentifiez-vous avec votre clé

Envoyez la clé dans l'en-tête X-Api-Key. Elle accorde le même accès que celui dont vous disposez à vos propres données.

bash

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

Paquet: @open-banking-io/client

npm
1

Installer

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

bash

npm install @open-banking-io/client
2

Connecter et appeler

Pointez le client vers votre credentials.json — chaque requête est authentifiée et chaque réponse déchiffrée en cours de traitement.

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éthodes

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.

Déployez sur Kubernetes
1

Créez le Secret

La clé credentials.json= renomme votre téléchargement daté en un nom de fichier propre à l'intérieur du cluster.

bash

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

Montez-le dans un Deployment

Montez le Secret en lecture seule et chargez-le dans votre code, par ex. 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