Webservices in einer Testumgebung
Anmeldung über Bestellschein
In der Testumgebung ist es nicht notwendig, ein Abonnement über das den Abonnementbedingungen beigefügte Bestellformular abzuschließen. Auch fallen in der Testumgebung keine Kosten für Webservices an.
Nutzung des Entwicklerportals
- Ein Profil anlegen
Melden Sie sich über https://developer.uat2.cbso.nbb.be/ an, um auf das Portal für technische Nutzer/Entwickler zuzugreifen. ╦Das Anlegen eines Profils ist erforderlich, um für jedes Produkt einen Schlüssel zu erhalten, der bei der Programmierung von Abfragen als Parameter verwendet werden muss.
Erstellen Sie über Sign up ein Konto und tragen Sie die geforderten Daten ein.
Klicken Sie auf „Sign up“, um Ihr Profil anzulegen. Anschließend erhalten Sie eine Bestätigungs-E-Mail von [email protected].
Danach können Sie sich über Sign in anmelden.
- Auswahl der Produkte
Sie können die verschiedenen Produkte über „Explore products“ oder „Products“ erkunden.
Die Webservices sind auf die folgenden Produkte aufgeteilt:
| Produkt | Inhalt |
|---|---|
| Authentic‑Query | Daten aus veröffentlichten Jahresabschlüssen einzeln beantragen und erhalten |
| Authentic‑Extract | Datenpakete aus veröffentlichten Hinterlegungen herunterladen → Zip-Datei |
| Improved | Daten anfordern und erhalten und von der BNB verbesserte Datenpakete herunterladen (PDF-Codierung, EURO-Umrechnungen, Korrekturen) |
Sie müssen sich für jedes Produkt einzeln registrieren.
Geben Sie einen Namen für jedes Produkt ein und klicken Sie auf „Subscribe“.
Bei jeder Registrierung erhalten Sie eine E-Mail, die Sie darüber informiert, dass Ihr Antrag geprüft und bearbeitet wird. Sobald die Registrierung genehmigt ist, können Sie mit der Arbeit beginnen.
Sie können dann die Registrierungen in Ihrem Profil sehen.
Für jedes Produkt erhalten Sie einen Primärschlüssel („Primary key“), den Sie durch Klicken auf „Show“ einsehen können.
Sie benötigen diesen Schlüssel als Parameter.
- E-Mails
Sie erhalten mehrere E-Mails vom Entwicklerportal unter der Adresse [email protected] mit dem Aliasnamen „NBB CBSO“: bei der Erstellung eines Profils, bei der Produktregistrierung, bei der Genehmigung einer Produktregistrierung.
Webservices Vorgänge
Um die möglichen Vorgänge zu veranschaulichen, verwenden wir Beispiele aus Postman.
https://www.postman.com/. Postman ist eine API-Plattform, mit der man APIs erstellen und nutzen kann.
Im Folgenden werden wir ihn nur als Webservice-Client verwenden, um die Ausgabe von HTTP-Anfragen vorzubereiten, zu senden und zu empfangen. Natürlich gibt es dafür Alternativen: proprietäre Software, SOAPUI etc.
Um Operationen der CBSO-Webservices durchzuführen, müssen Sie:
Die URL festlegen:
Außerdem müssen Sie die erforderlichen HTTP-Header oder Abfrageparameter bereitstellen:
- Der API-Schlüssel in „NBB-CBSO-Subscription-Key“ (Primary Key)
- Die ID der Anfrage in „X-Request-Id“
- Der Medientyp für das zurückgegebene Objekt in „Accept“.
UAT2 ist die Testumgebung für externe Benutzer (mit dem Servernamen „https://ws.uat2.cbso.nbb.be“ + Parameter).
Die möglichen Operationen für die verschiedenen Produkte sind:
| Produkt: AUTHENTIC-QUERY | ||
|---|---|---|
| 1 | Authentische Datenreferenzen erhalten | |
| 2 | Authentische PDF-Daten erhalten | |
| 3 | Authentische Xbrl-Daten erhalten | |
| 4 | Authentische Json-Daten erhalten | |
| Produkt: AUTHENTIC-EXTRACT | ||
| 5 | Alle Referenzen für ein bestimmtes Datum erhalten (Zip von JSON) | |
| 6 | Alle Bilder für ein bestimmtes Datum erhalten (Zip von PDF) | |
| 7 | Alle Daten für ein bestimmtes Datum erhalten (Zip von XBRL) | |
| 8 | Alle Daten für ein bestimmtes Datum erhalten (Zip von JSON) | |
| Produkt: IMPROVED | ||
| 9 | Referenzen für Verbesserungen für eine bestimmte ZDU-Nummer erhalten | |
| 10 | Die Verbesserungsreferenzen für eine bestimmte Verbesserungsreferenz erhalten | |
| 11 | Die PDF-Extraktionsdaten für eine bestimmte Verbesserungsreferenz erhalten | |
| 12 | Die in Euro umgerechneten Daten für eine bestimmte Verbesserungsreferenz erhalten. | |
| 13 | Die verbesserten Daten für eine bestimmte Verbesserungsreferenz erhalten. | |
| 14 | Alle Verbesserungsreferenzen erhalten | |
| 15 | Alle verbesserten Daten erhalten | |
Beispiele für Operationen und URL