RBB Konfigurator - Api Dokumentation

Basisdaten

Server Adresse
Verwenden Sie folgende Server Adresse für Test-Aufrufe:
https://rbb-konfigurator.web-service.de
Für den Produktivbetrieb ändert sich nur die Server Adresse, alles weitere bleibt identisch.
Ihre Kennung
Verwenden Sie folgende Kennung für Test Aufrufe:
demo
Für den Produktivbetrieb wird die Kennung von RBB einmalig bei der Einrichtung erstellt und Ihnen mitgeteilt.
Verwendete Ids
shopId Wird von Ihrem Shop erzeugt und beim Aufruf des Konfigurators übergeben. Wird bei Abschluss der Konfiguration oder Abbruch des Konfigurators wieder an Ihren Shop zurückgegeben.
sessionId Kann optional per Api erzeugt und beim Aufruf des Konfigurators übergeben werden, um den Konfigurator kundenspezifisch anzupassen. Wird nicht wieder an Ihren Shop zurückgegeben.
configurationId Wird vom Konfigurator erzeugt und kennzeichnet die erstellte Konfiguration des Kunden eindeutig. Wird bei Abschluss der Konfiguration an Ihren Shop übergeben.

Session für Konfigurator erstellen (optional)

POST <server>/api/session/<ihre-kennung>
Hiermit kann optional eine sessionId erzeugt werden, um den Konfigurator kundenspezifisch anzupassen.

Konfigurator starten

<server>/de/konfigurator/<ihre-kennung>?shopId=<ihre-shop-id>[&sessionId=<session-id>]
Demo Konfigurator starten

Abschluss der Konfiguration oder Abbruch des Konfigurators

1. Konfigurationsdaten an Shop übermitteln

Wenn der Kunde die Konfiguration abschließt, werden im ersten Schritt die Daten mit folgendem POST Request an den Shop übermittelt:
POST <callback-url>

2. Rücksprung zu Shop

Wenn der POST Request mit http Status 2xx (Success) antwortet, wird der Konfigurator im zweiten Schritt geschlossen und die Return URL des Shops aufgerufen.
GET <return-url>?shopId=<ihre-shop-id>

Alternativ: Konfigurator abbrechen

Der Kunde kann den Konfigurator jederzeit abbrechen. In dem Fall wird die Cancel URL des Shops aufgerufen.
GET <cancel-url>?shopId=<ihre-shop-id>