Documentation

Spécification OpenAPI

Toute l’API est décrite par un document OpenAPI 3. Utilisez-le pour générer des clients, importer l’API dans Postman ou Insomnia, ou l’explorer dans n’importe quel visualiseur OpenAPI.

Télécharger la spécification#

• v2 (actuelle) : /assets/openapi-v2.json
• En direct, toujours à jour & multilingue : https://companybelgium.be/api/openapi/{lang} (fr · en · nl)

Générer un client#

Pointez n’importe quel générateur vers la spécification, par exemple openapi-generator ou openapi-typescript, pour obtenir des bindings typés dans votre langage.

Importer dans Postman#

• Postman → Import → Link, puis collez l’URL de la spécification.
• Ajoutez un en-tête X-API-Key et X-API-Secret au niveau de la collection.
• Stockez-les comme variables de collection pour qu’ils n’apparaissent jamais dans les requêtes partagées.