IWS
Aus ITscope GmbH - Wissensbasis
1 Allgemein
Der ITscope Webservice (IWS) bietet Dienste zum Abruf von Information aus der ITscope-Datenbank.
Zur Nutzung der ITscope Webservices wird ein Schlüssel (Webservice-Key) benötigt. Dieser sorgt für die Verknüpfung der Abfrageergebnisse mit den kundenindividuellen Einstellungen (Preise, Datenprofile u.a.)
/**
* Beispielaussehen eines Itscope Web Service Keys (iwsKey)
*
*/
qnAGOar2dsAIo1EnThWsKADer Webservice-Key wird bei der Registrierung für eine Integration- oder Enterprise-Version oder auf Anfrage, bei bereits bestehenden MarketViewerverträgen durch ITscope mitgeteilt.
Bei Webservice Fehlern, werden die Fehlercodes im Header des Response übertragen.
2 Konzepte, Best Practices für die Integration in eigene Systeme
Eine Übersicht der benötigten Anleitungen und welche Arten von Integrationen möglich sind, können in diesem Bereich nachgeschlagen werden.
2.1 Hinweise zur Kommunikations mit dem Webservice
Die Anbindung an den ITscope Webservice läuft über die gleiche Kommunikations Schnittstelle wie der ITscope MarketViewer Client.
Um die Last auf unsere Server für jeden Benutzer optimal zu halten, greifen bei allen Teilnehmern Verbindungseinschränkungen bei dem Zugriff auf den Webservice. Übersteigen die offenen Verbindungen eines Teilnehmers den Wert von 150 im einem Zeitrahmen von 60 Sekunden, wird jede weitere Verbindung des Teilnehmer für 60 Sekunden mit einer Fehlermeldung HTTP 503 Rate Limit Exceeded. ITscope Web Service is limited to 150 requests per minute. aufgebaut. Erst nach 60 Sekunden können wieder erfolgreiche Verbindungen zu dem Webservice aufgebaut werden.
Damit es zu keinen Verbindungseinschränkungen kommt, gibt es mehrere möglichkeiten zur Kommunikation mit den Webservices.
- Es können z.B. mehrere Produkte auf einmal abgefragt werden. Wir empfehlen 500 Produkte pro Anfrage. Die maximale Größe eines Anfrage Headers liegen bei unserem Webservice bei 16 kb.
- Die Anfragen zeitverzögert senden, z.B. mit einer Pause von 5 Sekunden nach jeder Anfrage
- Immer einen Teilnehmer UserAgent setzen
2.2 Übersichtsseite für Fremdsystem Integrationen
2.3 Best Practices für Fremdsystem Integrationen (Warenwirtschaften, CRM, Onlineshops)
- Best Practices für Fremdsystem Integrationen (Warenwirtschaften, CRM, Onlineshops)
2.4 Profisuche (Technische Dokumentation der Produktsuche nach Merkmalen)
- Profisuche (Technische Dokumentation der Produktsuche nach Merkmalen)
2.5 Anbindung einer externen Anwendung direkt in den MarketViewer
- Anbindung einer externen Anwendung direkt in den MarketViewer
2.6 Lieferantenvergleich
3 Serviceübersicht
3.1 Web Service Version 2 (07/2007)
Die finale IWS2-Servicedefinition vom 19.07.2007. Diese Datei dient zur Beschreibung der angebotenen Funktionen, Daten, Datentypen und Austauschprotokolle des ITscope Web Services.
- WSDL - Web Service Description Language
http://iws.itscope.de/soapService/IWSPublic?wsdl
- Dokumentation IWS2
3.2 Web Service Version 3 (11/2009)
Die WSDL für den MarketViewer 3 - Web Service ist noch nicht final freigegeben.
- WSDL - Web Service Description Language
Derzeit noch BETA
- Dokumentation IWS3
4 Referenzdokumente / API
4.1 Web Service Version 2
- REST Methoden API (veraltet, bitte Version 3 verwenden)
- SOAP Methoden API (empfohlen)
4.2 Web Service Version 3
- REST Methoden API (empfohlen)
- SOAP Methoden API (Betaversion! Bitte Version 2 verwenden)
5 User-Agents
- Übermittlung der User-Agents Richtlinien und Hinweise für korrektes Setzen der User-Agents bei Webservice Abfragen
6 Beispiele
6.1 Codebeispiele
- Demoprojekt für SOAPUI enthält viele Beispiele für SOAP und REST Abfragen an die ITscope Web Services
- Ein Eclipse-Projekt zum Direktimport Beispiel Client Binding für Java 1.5 und JAXB.
- AJAXEnabledWebApplication Beispiel Client Anwendung mit IWS Webdienst Verweis in C-Sharp.
- WindowsFormsApplication Beispiel Client Anwendung mit IWS Webdienst Verweis in Visual Basic 2008.
- XSLT Stylesheet Beispiel einer XSLT für HTML Exporte.