BiPRO-BOX JSON API

Technische Referenz für die Integration der BiPRO-BOX JSON-Schnittstelle (Version 1.0)

Was ist diese Dokumentation?

Diese Dokumentation beschreibt alle Funktionen der JSON-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 (Postfach, Module, Extranet, Partner) nachschlagen. Menü links → jeweilige Funktion

Kommunikation

Senden Sie Ihren Request als JSON 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/json/v1.0
Content-Type: application/json; charset=utf-8
Accept: application/json
Cache-Control: no-cache
Pragma: no-cache
⚠ Zeichenkodierung
Request und Response verwenden UTF-8.

Authentifizierung

Für jeden Aufruf benötigen Sie einen _Security_Token_ im Element APIData.

ElementBedeutung
APIData._Security_Token_Token aus BiPRO-BOX: Einstellungen → externe Schnittstelle
APIData.actionName der aufzurufenden API-Funktion, z. B. listPostbox
PHP – Minimaler Request
$params = [
    'APIData' => [
        '_Security_Token_' => 'IHR_TOKEN',
        'action'           => 'listPostbox',
    ],
    'postbox' => [
        'postbox_folder' => 'inbox',
    ],
];

$ch = curl_init('https://www.bipro-box.de/app/core/api/json/v1.0');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => json_encode($params),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_TIMEOUT        => 30,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

Probleme beim Testen?

Senden Sie fehlerhafte Requests zur Protokollierung an:

https://www.bipro-box.de/app/core/api/json/v1.0log

Die Antwort enthält eine _LOG_ID_ – diese bitte mit einer kurzen Problembeschreibung an di@mr-money.de senden.