CBE2JSON JavaScript & TypeScript SDK
Raadpleeg gegevens van Belgische ondernemingen uit de KBO / BCE vanuit Node.js en TypeScript met de officiële CBE2JSON SDK: getypeerde resultaten, duidelijke fouten en je credits bij elke call.
Installatie
npm install @cbe2json/sdkNode.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.
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, een zoekopdracht 1 per teruggegeven onderneming; fouten, onbekende nummers en zoekopdrachten zonder resultaat verbruiken niets.
Fouten
Elk antwoord van de API heeft zijn eigen foutklasse:
NotFoundError— geen onderneming met dit nummerCreditsExhaustedError— niet genoeg credits meer deze maand, met de vernieuwingsdatumAuthenticationError— verkeerde client ID of geheime sleutelValidationError— een onjuist nummer of een onjuiste zoekopdracht