API BCE voorbeelden: oproepen in cURL, JavaScript en Python
Voorbeelden voor API BCE om te kopiëren: ondernemingsfiche, zoeken op naam of adres, btw-validatie via VIES en NACE-codes, in cURL, JavaScript en Python.
Copy-paste recipes for the most common tasks. Every call is authenticated (see Authentication).
Fetch an enterprise#
curl https://companybelgium.be/api/v2/enterprise/1033.022.383 \
-H "X-API-Key: $API_BCE_KEY" \
-H "X-API-Secret: $API_BCE_SECRET"Search by company name#
curl "https://companybelgium.be/api/v2/denominations?q=espero&limit=5" \
-H "X-API-Key: $API_BCE_KEY" -H "X-API-Secret: $API_BCE_SECRET"Search by address#
curl "https://companybelgium.be/api/v2/search/address?postalCode=1080&street=Colonne" \
-H "X-API-Key: $API_BCE_KEY" -H "X-API-Secret: $API_BCE_SECRET"Validate an EU VAT number#
curl "https://companybelgium.be/api/v2/vat/BE1033022383" \
-H "X-API-Key: $API_BCE_KEY" -H "X-API-Secret: $API_BCE_SECRET"Search NACE activity codes#
curl "https://companybelgium.be/api/v2/naces?q=programmation&version=2008&limit=10" \
-H "X-API-Key: $API_BCE_KEY" -H "X-API-Secret: $API_BCE_SECRET"Prefer to explore interactively? Open the API Playground and fire real requests from your browser.
De voorbeelden combineren tot echte workflows#
Elk voorbeeld toont één oproep. In de praktijk combineer je er echter meerdere. Hieronder staan drie workflows die teams vaak bouwen met API BCE. Ze gebruiken uitsluitend de endpoints uit de voorbeelden en de referentie.
Klant aanmaken in een CRM
Eerst typt de gebruiker een deel van de naam. Je roept dan /denominations aan met minstens 2 tekens en toont de suggesties. Vervolgens kiest de gebruiker een onderneming en haal je met het KBO-nummer de volledige fiche op. Ten slotte vul je naam, adres en NACE-activiteit automatisch in.
Factuur voorbereiden
Voordat je een factuur uitreikt, valideer je het btw-nummer via /vat/{vatNumber}. Is isValid onwaar, dan vraag je de klant om zijn gegevens te controleren. Zo voorkom je facturen met een fout btw-nummer.
Prospectielijst opbouwen
Zoek eerst de juiste NACE-codes via /naces. Combineer die daarna met een zoekopdracht op adres om ondernemingen in een bepaalde straat te vinden. Controleer ten slotte per resultaat de status, want ook stopgezette ondernemingen kunnen verschijnen.
Goede gewoonten bij het overnemen van voorbeelden#
- Vervang de voorbeeldsleutels door omgevingsvariabelen voordat je code commit.
- Voeg een time-out toe aan elk HTTP-verzoek. De voorbeelden laten dat weg voor de leesbaarheid.
- Controleer altijd
successen de HTTP-status voordat jedataleest. - Gebruik de testnummers uit de testmodus om elke workflow ook met slecht nieuws te testen.
De voorbeelden bestaan in cURL, JavaScript en Python. Werk je in een andere taal, dan is de vertaling meestal eenvoudig: het gaat telkens om een HTTPS-verzoek met twee headers. Een officiële SDK is er niet. Wil je toch getypeerde code, genereer dan een client uit de OpenAPI-specificatie.
Een laatste aandachtspunt is de verdeling van het werk. Bouw de workflows niet rechtstreeks in je schermen. Zet elke oproep liever in een kleine functie met een duidelijke naam, zoals "fiche ophalen" of "btw valideren". Combineer die functies daarna in je workflow. Zo kun je elke stap apart testen en later eenvoudig hergebruiken in een ander project. Bovendien wordt foutopsporing veel eenvoudiger, omdat je per stap ziet wat er misging.
Veelgestelde vragen over API BCE en de voorbeelden#
Kan ik de voorbeelden rechtstreeks in productie gebruiken?
Ze zijn een goed vertrekpunt, maar voeg zelf foutafhandeling, time-outs en veilig sleutelbeheer toe. De voorbeelden houden dat bewust kort.
Bestaat er een voorbeeld in PHP of Java?
De documentatie toont cURL, JavaScript en Python. Elke taal met een HTTP-client volstaat echter, want API BCE gebruikt gewoon HTTPS en JSON.
Hoe probeer ik een voorbeeld zonder code te schrijven?
Open de sandbox. Daar verstuur je dezelfde verzoeken vanuit je browser, met de demosleutel, testgegevens of je eigen sleutel.