Webservices in testomgeving
Inschrijven via bestelformulier
In testomgeving is het niet nodig om zich in te schrijven via het bestelformulier dat terug te vinden is als bijlage bij de abonnementsvoorwaarden. Er zijn ook geen kosten verbonden aan de webservices in testomgeving.
Gebruik van de ontwikkelaars portaalsite
- Aanmaak profiel
Connecteer via https://developer.uat2.cbso.nbb.be/ om toegang te krijgen tot de portaalsite bestemd voor technische gebruikers/ontwikkelaars. Aanmaak van een profiel is nodig om per product een sleutel te bekomen, die bij de programmatie van de requests als parameter gebruikt dient te worden.
Creëer een account via Sign up en vul de gevraagde gegevens in.
Klik op “Sign up” om je profiel aan te maken. Je zal vervolgens een e-mail krijgen voor confirmatie vanwege [email protected].
Daarna kan je inloggen via Sign in.
- Producten selecteren
Je kan de verschillende producten verkennen via “Explore products” of “Products”.
De webservices zijn opgedeeld in de volgende producten:
| Product | Content |
|---|---|
| Authentic‑Query | Opvragen en verkrijgen van gegevens van gepubliceerde jaarrekeningen, één voor één |
| Authentic‑Extract | Datapakketten van gepubliceerde neerleggingen downloaden → Zip-bestand |
| Improved | Gegevens opvragen en verkrijgen & pakketten downloaden van door NBB verbeterde gegevens (inbreng PDF, omzettingen naar EURO, correcties) |
U dient zich voor elk product apart in te schrijven.
Geef per product een naam in en klik op “Subscribe”
Per inschrijving zal u een mail ontvangen met de melding dat uw aanvraag zal nagekeken en behandeld worden. Van zodra de inschrijving wordt goedgekeurd, kan u aan de slag.
In je profiel kan je dan de inschrijvingen terugvinden.
Per product krijgt u een Primary key die u kan visualiseren door op Show te klikken.
Deze key hebt u nodig als parameter.
- Mails
Je zal vanuit het developers portaal vanwege [email protected] verschillende e-mails ontvangen met alias naam “NBB CBSO”: bij aanmaak profiel, bij inschrijving per product, bij goedkeuring van inschrijving per product.
Webservices transacties
Om de mogelijke transacties te illustreren, maken we gebruik van voorbeelden via Postman.
https://www.postman.com/. Postman is een API platform om APIs op te bouwen en te gebruiken.
In wat volgt, gebruiken we dit enkel als webservice klant om output van HTTP requests voor te bereiden, te versturen en te ontvangen. Uiteraard zijn er hiervoor alternatieven: eigen software, SOAPUI, enz.
Om transacties van de CBSO webservices uit te voeren dient u:
De URL te definiëren:
Je moet tevens de nodige HTTP headers of query parameters opgeven:
- De API key in ‘NBB-CBSO-Subscription-Key’ (Primary Key)
- De request ID in ‘X-Request-Id’
- Het media type voor het geretourneerde object in ‘Accept’
UAT2 is de testomgeving voor externe gebuikers (met server name ‘https://ws.uat2.cbso.nbb.be’ + parameters).
Mogelijke transacties voor de verschillende producten zijn :
| AUTHENTIC-QUERY API Name : authentic | ||
|---|---|---|
| 1 | Verkrijg authentieke gegevens Refertes | |
| 2 | Verkrijg authentieke gegevens Pdf | |
| 3 | Verkrijg authentieke gegevens Xbrl | |
| 4 | Verkrijg authentieke gegevens Json | |
| AUTHENTIC-EXTRACT API Name : extracts | ||
| 5 | Verkrijg alle refertes voor een opgegeven datum (Zip of JSON) | |
| 6 | Verkrijg alle beelden voor een opgegeven datum (Zip of PDF) | |
| 7 | Verkrijg alle gegevens voor een opgegeven datum (Zip of XBRL) | |
| 8 | Verkrijg alle gegevens voor een opgegeven datum (Zip of JSON) | |
| IMPROVED API Name : improved | ||
| 9 | Verkrijg refertes voor verbeteringen voor een gegeven KBO-nummer | |
| 10 | Verkrijg refertes voor verbeteringen voor een gegeven verbeteringsreferte | |
| 11 | Verkrijg PDF extractie gegevens voor een gegeven verbeteringsreferte | |
| 12 | Verkrijg naar Euro geconverteerde gegevens voor een gegeven verbeteringsreferte | |
| 13 | Verkrijg gecorrigeerde gegevens voor een gegeven verbeteringsreferte | |
| 14 | Verkrijg alle refertes voor verbeteringen | |
| 15 | Verkrijg alle verbeterde gegevens | |
Voorbeelden van transacties en url’s