BiPRO-BOX XML API
Technische Referenz für die Integration der BiPRO-BOX XML-Schnittstelle (Version 1.0)
Was ist diese Dokumentation?
Diese Dokumentation beschreibt alle Funktionen der XML-API der BiPRO-BOX. Sie richtet sich an Softwareentwickler, die Postfächer, Module, Extranet-Zugänge und Partnerdaten in externe Systeme integrieren.
Wo fange ich an?
▶ Tipp: Beginnen Sie mit der Fehlercode-Referenz und einem einfachen Aufruf von listPostbox, um Request und Response kennenzulernen.
| Schritt | Was tun? | Wohin? |
|---|---|---|
| 1 | API-Endpunkt, Authentifizierung und Request-Format verstehen. | Kommunikation → |
| 2 | _Security_Token_ in der BiPRO-BOX anlegen und in APIData mitsenden. |
Authentifizierung → |
| 3 | Konkrete Funktionen nachschlagen. | Menü links → jeweilige Funktion |
Kommunikation
Senden Sie Ihren Request als XML im Body (raw_post_data) per HTTPS-POST:
HTTP – Request-Format
Protokoll: https
Verfahren: POST (raw_post_data)
URL: https://www.bipro-box.de/app/core/api/xml/v1.0
Content-Type: application/xml; charset=utf-8
Accept: application/xml
Cache-Control: no-cache
Pragma: no-cache
⚠ Zeichenkodierung
Request und Response verwenden UTF-8.
Request und Response verwenden UTF-8.
Authentifizierung
Für jeden Aufruf benötigen Sie einen _Security_Token_ im Element APIData.
| Element | Bedeutung |
|---|---|
APIData._Security_Token_ | Token aus BiPRO-BOX: Einstellungen → externe Schnittstelle |
APIData.action | Name der aufzurufenden API-Funktion |
Probleme beim Testen?
Senden Sie fehlerhafte Requests zur Protokollierung an:
https://www.bipro-box.de/app/core/api/xml/v1.0log
Die Antwort enthält eine _LOG_ID_ – diese bitte mit einer kurzen Problembeschreibung an di@mr-money.de senden.