http://wiki.dstore.de/ 2026-05-03T16:02:23+0200 http://wiki.dstore.de/ http://wiki.dstore.de/lib/tpl/dstore/images/favicon.ico text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/access?rev=1415876767&do=diff Zugriffsmöglichkeiten Der Zugriff auf das webservice_SmartGate erfolgt per HTTP bzw. HTTPS. Infos zum Aufbau der URLs gibt in der Einleitung im Abschnitt Plattform Zugriff. Im Abschnitt Hilfsprogramme haben wir eine Übersicht mit nützlichen Tools zusammengestellt. Für folgende Programmiersprachen haben wir bereits spezielle Clients entwickelt: text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/applicationsettings?rev=1415876767&do=diff Konfiguration via ApplicationSettings Das Verhalten des webservice_SmartGates kann über ApplicationSettings gesteuert werden. Änderungen an der Konfiguration erfordern die Berechtigung „globale“ Einstellungen zu ändern, da es im webservice_SmartGate keine Benutzer-spezifischen Einstellungen gibt. text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/architecture?rev=1415876767&do=diff webservice_SmartGate Aufbau Das folgende Diagramm zeigt den Aufbau des webservice_SmartGates und die Gliederung in drei Bereiche. Die Bereiche finden sich auch im Aufbau der URLs wieder. Bereiche /engine Dieser Bereich ist mit Abstand der mächtigste Bereich des text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/caching?rev=1415876767&do=diff Caching Allgemein Aus Performance-Gründen werden Antworten vom webservice_SmartGate von einem zwischengeschalteten (transparenten) Reverse-Proxy gecached. Ob eine Anfrage gecached wurde erkennt man am X-Cache-Status-Header. Dieser kann folgende Werte haben: text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/custom_clients?rev=1415876767&do=diff Eigene webservice_SmartGate Clients Best-Practices allgemein Folgende Best-Practices haben sich unabhängig der Programmiersprache des Clients bei der Entwicklung eigener Zugriffsbibliotheken bewährt: * Verwenden Sie eine für Ihre Sprache/Plattform vorhandene, verbreitete und stabile Bibliothek für das durchführen der HTTP(S)-Zugriffe (siehe auch text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/engine?rev=1415876767&do=diff Die Methoden engine/... Jede Methode dieses Bereichs entspricht einer gespeicherten Prozedur der SmartEngine. Eine Liste aller verfügbaren Prozeduren finden Sie unter Liste der Engine-Prozeduren. Eine Ausnahme bilden die beiden folgenden Methoden, die bei der Ausführung von Prozeduren unterstützen: text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/engine_datatypes?rev=1415876767&do=diff Datentypen im Bereich "engine" Wie an anderen Stellen bereits besprochen führen alle Anfragen auf Methoden des Breichs „engine“ zum Aufruf einer gespeicherten Prozedur (stored procedure). Die SmartEngine nutzt im wesentlichen die folgenden Datentypen für Parameter und Ergebnismengen: text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/engine_parameterconventions?rev=1415876767&do=diff Parameter-Konventionen engine/<Prozedur-Name> Hinsichtlich der Parameterübergabe bei Methoden engine/<Prozedur-Name> gelten folgende Konventionen: * Es sind nur Parameter erlaubt, die die entsprechende Prozedur auch unterstützt. Dies sei hier erwähnt, da bei anderen Methoden des text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/engineplayground?rev=1415876767&do=diff Engine-Playgorund Mit unserem „Engine-Playground“ unter <http://playground.dstore.de>, können Sie mit den Prozeduren des /engine-Bereichs „rumspielen“. Bitte beachten Sie, dass der Engine-Playground mit der dbap-demo Umgebung verknüpft ist. text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/errorhandling?rev=1415876767&do=diff Clientseitige Fehlerbehandlung :!: Die folgenden Informationen beziehen sich auf Versionen ab 1.20 des webservice_SmartGate. Grundsätzlich Um zu erkennen ob es bei der Ausführung des Requests einen Fehler gab, prüft man auf das Vorhandensein eines Elementes text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-get-faceted-search?rev=1415876767&do=diff Facetten-Navigation Das Prinzip der Facetten-Navigation (andere Bezeichnungen sind Facetten Search, Guided Navigation oder „Search and Navigation“) hilft Nutzern, sich besonders rasch zu orientieren, indem es Suchergebnisse in einem Zusammenhang präsentiert und diesen zusätzlich nach weiteren Kategorien und der Anzahl der jeweils enthaltenen Elemente aufschlüsselt: Ein Produktfilter gibt Auskunft über weitere Differenzierungsmöglichkeiten bei der Suche, sodass der Nutzer per Mausklick zu einer … text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-get-filtersyntax?rev=1415876767&do=diff Filter-Syntax item/get Zur Filterung der Artikeldaten mittels item/get wird über Index-Felder eingeschränkt. Die Filter werden als Query-Parameter übergeben und brauchen nicht vorher speziell konfiguriert werden (siehe Konfiguration und Parameter). Die hier beschriebenen Filter lassen sind mit der text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-get-index?rev=1415876767&do=diff Der NoSQL-Index Die Index für die Methoden des Bereichs item/ ist ein NoSQL-Index. Intern wird dafür Apache Lucene verwendet. Der Index wird mittels des Index Maintainers regelmäßig aktualisiert. Inhalt Der Index enthält die mittels ApplicationSettings (unter: GeneralSettings/Mappings/NodeCharacteristics text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-get-maintainer?rev=1415876767&do=diff GetItems-Index-Maintainer Dieser zeitgesteuerte Job ist dafür zuständig die Artikeldaten aus der SQL-Datenbank in den NoSQL-Datenspeicher zu übertragen (siehe auch Diagramm). Dabei wird getrennt nach * Teil-Updates (in der Regel 10 minütlich) text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-get-paginationsorting?rev=1415876767&do=diff Paginierung und Sortierung Paginierung Für die Paginierung sind die Parameter RowCount und StartAtRowNo zuständig (siehe Konfiguration item/get. Sie erlauben es immer eine bestimmte Zahl an „Item“-Elemente ab einem Startpunkt zu erhalten. Die Gesamtzahl der Artikel ( text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-get-parametersandsettings?rev=1415876767&do=diff Konfiguration und Parameter item/get Allgemeines Die Methode item/get hat als einzigen Pflicht-Parameter den Parameter „Template“. Dieser steuert welche Konfiguration im jeweiligen Request verwendet werden soll und damit die weiteren Parameter. Neben den weiter unten beschriebenen, fest benannten Parametern kann jeder Feldname des text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-get-search?rev=1415876767&do=diff Freitextsuche mit Relevanzsortierung Die Freitextsuche mit Relevanzsortierung wird über den Query-Parameter „Search“ gesteuert und lässt sich mit Filtern über Index-Felder kombinieren. Die Suche erstreckt sich über alle Felder mit Artikelmerkmalen des Index und zusätzlich über NodeDescription und Predecessor-NodeDescriptions. Bei mehreren Wörtern wird überprüft, ob die einzelnen Suchbegriffe mit UND verknüpft ein Ergebnis liefern. Ist dies nicht der Fall, werden sie mit ODER verknüpft. Per Pa… text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-get?rev=1415876767&do=diff item/get Die Methode item/get ermöglicht die Ermittlung von Artikeldaten aus dem NoSQL-Index, welcher in regelmäßigen Intervallen durch den Index-Maintainer aktualisiert wird. Die verwendeten Daten sind daher nicht Echtzeit-Daten, dafür ist die Ermittlung aber sehr performant und mächtiger als über den Weg einer SQL-Datenbank. text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-getbinary?rev=1415876767&do=diff item/getBinary Diese Methode dient dazu Binaries (Bilder und andere „Medien“) mit Bezug zu Artikeln zu ermitteln. Binaries können sowohl in der Datenbank (BLOB, vgl. im_GetBinary_Pu) als auch im Dateisystem hinterlegt sein und sind in „Typen“ (Produktansicht, Handbuch etc.) organisiert. text/html 2014-11-13T12:06:07+0200 Anonymous (anonymous@undisclosed.example.com) http://wiki.dstore.de/webservice/item-getsearchproposals?rev=1415876767&do=diff item/getSearchProposals Die Methode item/getSearchProposals ermöglicht die Ermittlung von Vorschlägen während einer Nutzereingabe in einem Suchfeld („Suggest“). Datengrundlage ist der auch in der item/get Methode verwendete NoSQL-Index, welcher in regelmäßigen Intervallen durch den