Webservices en environnement de test

Inscription via bon de commande

Dans l'environnement de test, il n'est pas nécessaire de s'abonner via le bon de commande qui est joint aux conditions d'abonnement. Il n'y a pas non plus de coûts liés aux Webservices en environnement de test.

Utilisation du portail développeur

  • Créer un profil

Connectez-vous via https://developer.uat2.cbso.nbb.be/ pour accéder au portail destiné aux utilisateurs/développeurs techniques. La création d'un profil est nécessaire pour obtenir une clé pour chaque produit, qui doit être utilisée comme paramètre lors de la programmation des requêtes.

Créez un compte via Sign up et remplissez les données demandées.

Cliquez sur “Sign up” pour créer votre profil. Vous recevrez ensuite un e-mail de confirmation de la part d' apimgmt-noreply@mail.windwsazure.com.

Ensuite, vous pouvez vous connecter via Sign in.

  • Sélection des produits

Vous pouvez explorer les différents produits via “Explore products” ou “Products”.

Webservices en environnement de test - Sélection des produits - 1

Les webservices sont répartis entre les produits suivants :

Produit Contenu
Authentic‑Query Demander et obtenir les données des comptes annuels publiés, un par un
Authentic‑Extract Télécharger les paquets de données des dépôts publiés → Fichier Zip
Improved Demander et obtenir des données et télécharger des paquets de données corrigées par la BNB (encodage PDF, conversions en EURO, corrections)

Vous devez vous inscrire pour chaque produit séparément.

Saisissez un nom pour chaque produit et cliquez sur “Subscribe”

Pour chaque inscription, vous recevrez un e-mail vous informant que votre demande sera vérifiée et traitée. Dès que l'enregistrement est approuvé, vous pouvez commencer à travailler.

Vous pourrez alors voir les inscriptions dans votre profil.
Pour chaque produit, vous recevrez une clé primaire (“Primary key”) que vous pourrez visualiser en cliquant sur “Show”.
Vous avez besoin de cette clé comme paramètre.

  • Emails

Vous recevrez plusieurs e-mails du portail des développeurs à l'adresse apimgmt-noreply@mail.windwsazure.com avec le nom aliast "NBB CBSO" : lors de la création d'un profil, lors de l'enregistrement par produit, lors de l'approbation d'un enregistrement par produit.

Webservices in testomgeving - Mails - 1

Webservices opérations

Pour illustrer les opérations possibles, nous utilisons des exemples tirés de Postman.

https://www.postman.com/. Postman est une plateforme d'API permettant de créer et d'utiliser des API.

Dans ce qui suit, nous l'utiliserons uniquement en tant que client de webservices pour préparer, envoyer et recevoir la sortie des requêtes HTTP. Bien sûr, il existe des alternatives pour cela : logiciels propriétaires, SOAPUI, etc.

Pour effectuer des opérations des webservices de la CBSO, vous devez :

Définissez l'URL:  

Vous devez également fournir les en-têtes HTTP ou les paramètres de requête nécessaires :

- La clé API dans 'NBB-CBSO-Subscription-Key' (Primary Key)
- L'ID de la demande dans "X-Request-Id"
- Le type de média pour l'objet retourné dans "Accept"

Webservices en environnement de test - Webservices opérations - 2

UAT2 est l'environnement de test pour les utilisateurs externes (avec le nom de serveur ‘https://ws.uat2.cbso.nbb.be’),
UAT1 est l'environnement de test pour l'utilisation interne de la BNB (avec le nom de serveur ‘https://ws.uat1.cbso.be’).

Les opérations possibles pour les différents produits sont :

Produit : AUTHENTIC-QUERY
1 Obtenir des références de données authentiques
2 Obtenir des données authentiques Pdf
3 Obtenir des données authentiques Xbrl
4 Obtenir des données authentiques Json
Produit : AUTHENTIC-EXTRACT
5 Obtenir toutes les références pour une date donnée (Zip de JSON)
6 Obtenir toutes les images pour une date donnée (Zip de PDF)
7 Obtenir toutes les données pour une date donnée (Zip of XBRL)
8 Obtenir toutes les données pour une date donnée (Zip de JSON)
Produit : IMPROVED
9 Obtenir les références d'améliorations pour un numéro BCE donné
10 Obtenir les références d'améliorations pour une référence d'amélioration donnée
11 Obtenir les données d'extraction de PDF pour une référence d'amélioration donnée
12 Obtenir les données converties en euros pour une référence d'amélioration donnée.
13 Obtenir les données corrigées pour une référence d'amélioration donnée
14 Obtenir toutes les références d’améliorations
15 Obtenir toutes les données améliorées

Exemples d'opérations et d'url

AUTHENTIC-QUERY API Name : authentic
  Transactie URL
1 application/json https://ws.uat2.cbso.nbb.be/authentic/legalEntity/0403101811/references
2 application/pdf https://ws.uat2.cbso.nbb.be/authentic/deposit/2021-00000132/accountingData
3 application/x.xbrl https://ws.uat2.cbso.nbb.be/authentic/deposit/2021-00000132/accountingData
4 application/x.jsonxbrl https://ws.uat2.cbso.nbb.be/authentic/deposit/2021-00000132/accountingData
AUTHENTIC-EXTRACT API Name : extracts
  Transactie URL
5 application/x.zip+pdf https://ws.uat2.cbso.nbb.be/extracts/batch/2021-12-14/accountingData
6 application/x.zip+xbrl https://ws.uat2.cbso.nbb.be/extracts/batch/2021-12-14/accountingData
7 application/x.zip+jsonxbrl https://ws.uat2.cbso.nbb.be/extracts/batch/2021-12-14/accountingData
8 application/x.zip+json https://ws.uat2.cbso.nbb.be/extracts/batch/2021-12-14/references
IMPROVED API Name : improved
  Transactie URL
9 application/json https://ws.uat2.cbso.nbb.be/improved/legalEntity/0403834160/
references/improved
10 application/json https://ws.uat2.cbso.nbb.be/improved/deposit/
2021-00000160/references/improved
11 application/x.jsonxbrl https://ws.uat2.cbso.nbb.be/improved/deposit/
2021-00000160/accountingData/improved/pdf_extracted
12 application/x.jsonxbrl https://ws.uat2.cbso.nbb.be/improved/deposit/
2021-00000160/accountingData/improved/euro_converted
13 application/x.jsonxbrl https://ws.uat2.cbso.nbb.be/improved/deposit/
2021-00000010/accountingData/improved/corrected
14 application/x.zip+json https://ws.uat2.cbso.nbb.be/improved/batch/
2021-10-10/references/improved
15 application/x.zip+jsonxbrl https://ws.uat2.cbso.nbb.be/improved/batch/
2021-10-10/accountingData/improved