CBE2JSON JavaScript & TypeScript SDK

Installatie

npm install @cbe2json/sdk

Node.js 20 of recenter. Werkt met import en require, bevat eigen TypeScript-types en heeft geen dependencies.

Een onderneming opzoeken

Maak een API-sleutel aan in je dashboard en bewaar de client ID en de geheime sleutel in omgevingsvariabelen. Gebruik de SDK op je server: de geheime sleutel mag nooit in een browser terechtkomen.

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`)

Zoeken op naam

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

De zoekopdracht kijkt naar de namen van ondernemingen en vestigingen, tot 100 resultaten per call. Zonder resultaat krijg je een lege lijst.

Ondernemingen vinden

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 zoekt ondernemingen op activiteit (NACE), postcode, gemeente, straat en huisnummer, naam, rechtsvorm of rechtstoestand, tot 100 per call. NACE- en adresfilters moeten op dezelfde zetel of dezelfde vestigingseenheid slaan, en match vertelt je welke overeenkwamen. findNumbers neemt dezelfde filters en geeft alleen ondernemingsnummers terug, tot 1000 per pagina. Gebruik ze om bedrijven op te zoeken of te verifiëren, bijvoorbeeld wie op een bepaald adres gevestigd is; de KBO Open Data-licentie sluit direct marketing uit.

Credits

Elk resultaat vermeldt de credits die de call verbruikte, de resterende credits, je maandelijkse tegoed en wanneer het vernieuwt. Een opzoeking op nummer verbruikt 1 credit, search en find 1 per teruggegeven onderneming, findNumbers 1 per pagina met resultaten; fouten, onbekende nummers en lege resultaten verbruiken niets.

Fouten

Elk antwoord van de API heeft zijn eigen foutklasse:

• NotFoundError — geen onderneming met dit nummer
• CreditsExhaustedError — niet genoeg credits meer deze maand, met de vernieuwingsdatum
• AuthenticationError — verkeerde client ID of geheime sleutel
• ValidationError — een onjuist nummer of een onjuiste zoekopdracht

Links

• npm — @cbe2json/sdk
• GitHub — creacore-team/cbe2json-sdk
• API-documentatie