Plattform Zugriff

Der Zugriff auf die Komponenten der Plattform erfolgt per HTTP bzw. HTTPS.

Die URLs für den Zugriff auf das webservice_SmartGate sind so aufgebaut:

http://<Partner>-<Projekt>.dstore.de/<API-Key>/<Bereich>/<Methode>?<Parameter>=<Wert>

• Partner Das Kürzel des Partners dem das Projekt zugeordnet ist
• Projekt Das Kürzel des Projektes.
• API-Key Schlüssel für den Zugriff der zwingend benötigt wird. Ist noch kein Schlüssel vorhanden kann 'default' als API-Key verwendet werden. Der API-Key wird auch als 'AccessKey' bezeichnet.
• Bereich Bereich auf den zugegriffen werden soll (z.B. 'item' oder 'engine')
• Methode Name der Methode die aufgerufen werden soll (z.B. 'get' oder 'mi_GetUnits')
• Parameter Parameter der Methode (Je nach Methode können auch keine Parameter erforderlich sein, bzw. ein POST-Body notwendig sein)

Falls Sie noch kein Partner-Kürzel haben beachten Sie unsere Hinweise zum Demo- und Testzugang.

Folgende Bereiche stehen im webservice_SmartGate zur Zeit zur Verfügung:

• engine Enthält alle Funktionalitäten der SmartEngine als Methode
• item Enthält Methoden zum Zugriff auf Produktdaten, insbesondere eine Freitextsuche mit Relevanzsortierung in Kombination mit einer Facetten-Suche
• service Enthält die Methoden zur Verwaltung des webservice_SmartGates

Bestimmte Methoden erfordern eine Authentifizierung die über den API-Key hinaus geht. In welchen Fällen dies erforderlich ist kann dem Hilfesystem entnommen werden oder wird durch den entsprechenden HTTP-Status-Code zurückgemeldet.

Die Authentifizierung erfolgt per HTTP-Basic-Auth. Die Anfrage muss dann zwingend über das https-Protokoll (verschlüsselt) erfolgen. Informationen über die verschiedenen Arten von Benutzern findet sie unter Benutzer und Logins.

Unter der folgenden URL findet sich ein Hilfesystem mit Freitextsuche und einer Liste aller verfügbaren Methoden des webservice_SmartGates.

http://<Partner>-<Projekt>.dstore.de/default

Das Hilfesystem unserer Demo-Version finden sie hier: http://dbap-demo.dstore.de/default

Das admin_SmartGate wird über die folgende URL über einen Webbrowser gestartet¹⁾:

http://<Partner>-<Projekt>.dstore.de/admin

Die Anmeldung erfolgt in einem Login-Fenster, welches bei jedem Programmstart innerhalb der Anwendung angezeigt wird.

Das xml_SmartGate wird über die folgende Basis-URL angesteuert:

http://<Partner>-<Projekt>.dstore.de/xml

Die Anmeldung erfolgt ….

• files Unter diesem Bereich besteht ein Datei-Zugriff per https und WebDAV-Protokoll zur Ablage bestimmter Konfigurationsdateien (Templates für E-Mail, Synonymwörterlisten für die Suche etc.) und zum Abruf von Logfiles und Listen