SDK JavaScript & TypeScript CBE2JSON

Accédez aux données des entreprises belges de la BCE / KBO depuis Node.js et TypeScript avec le SDK officiel CBE2JSON : des résultats typés, des erreurs claires et vos crédits à chaque appel.

Installation

npm install @cbe2json/sdk

Node.js 20 ou plus récent. Fonctionne avec import et require, inclut ses types TypeScript et n'a aucune dépendance.

Rechercher une entreprise

Créez une clé API dans votre tableau de bord et gardez son client ID et sa clé secrète dans des variables d'environnement. Utilisez le SDK côté serveur : la clé secrète ne doit jamais arriver dans un navigateur.

import { CBE2JSON } from '@cbe2json/sdk'

const cbe = new CBE2JSON({
  clientId: process.env.CBE2JSON_CLIENT_ID!,
  secretKey: process.env.CBE2JSON_SECRET_KEY!,
})

const { data: company, meta } = await cbe.companies.get('0202.239.951')

console.log(company.enterpriseNumber, company.denominations[0]?.denomination)
console.log(`${meta.creditsRemaining} credits left`)

Rechercher par nom

const { data, meta } = await cbe.companies.search({ name: 'Proximus', limit: 20 })
console.log(`${meta.total} matches`, meta.hasNext)

La recherche porte sur les noms des entreprises et des établissements, jusqu'à 100 résultats par appel. Sans résultat, vous recevez une liste vide.

Crédits

Chaque résultat indique les crédits utilisés par l'appel, les crédits restants, votre quota mensuel et sa date de remise à zéro. Une recherche par numéro consomme 1 crédit, une recherche par nom 1 crédit par entreprise renvoyée ; les erreurs, les numéros inconnus et les recherches sans résultat n'en consomment aucun.

Erreurs

Chaque réponse de l'API a sa propre classe d'erreur :

  • NotFoundError — aucune entreprise n'a ce numéro
  • CreditsExhaustedError — plus assez de crédits ce mois-ci, avec la date de remise à zéro
  • AuthenticationError — client ID ou clé secrète incorrects
  • ValidationError — numéro ou recherche mal formés

Liens

Obtenir une clé API gratuite