OpenAPI 3.1
Spécification OpenAPI v2
La spécification OpenAPI décrit l'ensemble des endpoints, paramètres, réponses et schémas de l'API v2 dans un format standard lisible par les machines. Utilisez-la pour générer des clients SDK, importer dans Postman, ou valider vos intégrations.
Télécharger la spécification
Téléchargement via CLI
bash
# Télécharger le fichier OpenAPI v2 curl -o openapi-v2.json https://companybelgium.be/api/v2/openapi # Valider le schéma avec openapi-generator npx @openapitools/openapi-generator-cli validate -i openapi-v2.json
Cas d'utilisation
Génération de SDK
Générez automatiquement un client TypeScript, Python, Go ou Java à partir de la spécification.
Import Postman / Insomnia
Importez le fichier dans Postman ou Insomnia pour tester les endpoints avec une interface graphique.
Générer un client SDK
TypeScript / JavaScript
bash
npx openapi-typescript https://companybelgium.be/api/v2/openapi -o ./src/api-types.ts # Ou avec openapi-generator npx @openapitools/openapi-generator-cli generate \ -i https://companybelgium.be/api/v2/openapi \ -g typescript-fetch \ -o ./src/generated/companybelgium
Python
bash
pip install openapi-python-client openapi-python-client generate \ --url https://companybelgium.be/api/v2/openapi \ --output-path ./companybelgium_client
Postman
bash
# 1. Ouvrir Postman # 2. File > Import > Link # 3. Coller l'URL : https://companybelgium.be/api/v2/openapi # 4. Cliquer sur "Import" # 5. Tous les endpoints v2 sont prêts à tester
Endpoints couverts
| Catégorie | Endpoints | Nombre |
|---|---|---|
| Entreprise | detail, activities, address, contact, denominations, establishments, financial, roles | 8 |
| Établissement | detail, activities, address, contact, denominations, denomination/{language} | 6 |
| Données de référence | naces, nace/{version}/{code}, juridical-forms, denominations | 4 |
| TVA | vat/{vatNumber} (validation VIES) | 1 |
| Compte | me (introspection) | 1 |
| Webhooks | list, create, get, delete, subscriptions, events, trigger, hmac-secret | 8 |
| Total | 28 |