SDK JavaScript & TypeScript CBE2JSON

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.

Trouver des entreprises

const { data } = await cbe.companies.find({
  zipcode: '1000',
  street: 'Rue de la Loi',
  houseNumber: '16',
})
for (const company of data) {
  console.log(company.enterpriseNumber, company.match)
}

const numbers = await cbe.companies.findNumbers({
  zipcode: '1000',
  street: 'Rue de la Loi',
})
console.log(`${numbers.meta.total} companies on this street`)

find retrouve des entreprises par activité (NACE), code postal, commune, rue et numéro, nom, forme juridique ou situation juridique, jusqu'à 100 par appel. Les filtres NACE et adresse doivent correspondre au même siège ou à la même unité d'établissement, et match indique lesquels correspondent. findNumbers prend les mêmes filtres et ne renvoie que les numéros d'entreprise, jusqu'à 1000 par page. Utilisez-les pour rechercher ou vérifier des entreprises, par exemple qui est domicilié à une adresse donnée ; la licence BCE Open Data exclut le marketing direct.

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, search et find 1 crédit par entreprise renvoyée, findNumbers 1 crédit par page avec résultats ; les erreurs, les numéros inconnus et les résultats vides 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

• npm — @cbe2json/sdk
• GitHub — creacore-team/cbe2json-sdk
• Documentation de l'API