Anbindung an WebServices Robert Zacherl

Transkript

1 Anbindung an WebServices Robert Zacherl

2 WebServices Definition Wikipedia: Ein Webservice (auch Webdienst) ermöglicht die Maschine-zu-Maschine-Kommunikation auf Basis von HTTP oder HTTPS über Rechnernetze wie das Internet. Dabei werden Daten ausgetauscht und auf entfernten Computern Funktionen aufgerufen. Jeder Webservice besitzt einen Uniform Resource Identifier (URI), über den er eindeutig identifizierbar ist, sowie eine Schnittstellenbeschreibung in maschinenlesbarem Format (als XML-Artefakt, z. B. WSDL), die definiert, wie mit dem Webservice zu interagieren ist. Die Kommunikation kann (muss aber nicht) über Protokolle aus dem Internetkontext wie HTTP laufen und kann XML oder JSON basiert sein.

3 Uniform Resource Identifier (URI) Definition Wikipedia: Ein Uniform Resource Identifier (Abk. URI, englisch für einheitlicher Bezeichner für Ressourcen) [...] besteht aus einer Zeichenfolge, die zur Identifizierung einer abstrakten oder physischen Ressource dient. URIs werden zur Bezeichnung von Ressourcen (wie Webseiten, sonstigen Dateien, Aufruf von Webservices, aber auch z. B. -Empfängern) im Internet [...] eingesetzt. Aufbau: Nach dem aktuellen Standard RFC 3986 besteht ein URI aus fünf Teilen: scheme (Schema oder Protokoll), authority (Anbieter oder Server), path (Pfad), query (Abfrage) und fragment (Teil)

4 Uniform Resource Locator (URL) Definition Wikipedia: Ein Uniform Resource Locator (Abk. URL; englisch für einheitlicher Ressourcenzeiger) identifiziert und lokalisiert eine Ressource, beispielsweise eine Website über die zu verwendende Zugriffsmethode (zum Beispiel das verwendete Netzwerkprotokoll wie HTTP oder FTP) und den Ort (engl. location) der Ressource in Computernetzwerken. [...] Aufbau: Der grundsätzliche URL-Aufbau besteht aus einer die Zugriffsmethode festlegenden Schema- Bezeichnung [...] und einem Schema-spezifischen Teil [...], die durch einen Doppelpunkt getrennt sind:

5 HTTP-Authentifizierung Definition (Wikipedia) HTTP-Authentifizierung ist ein Verfahren, mit dem sich der Nutzer eines Webbrowsers gegenüber dem Webserver bzw. einer Webanwendung als Benutzer authentifizieren kann, um danach für weitere Zugriffe autorisiert zu sein. Verfahren Basic Authentication Die Basic Authentication (Basisauthentifizierung) ist die häufigste Art der HTTP-Authentifizierung. Der Webserver fordert eine Authentifizierung an. Der Browser sucht daraufhin nach Benutzername/Passwort für diese URL und fragt gegebenenfalls den Benutzer. Anschließend sendet er die Authentifizierung mit dem Authorization-Header in der Form Benutzername:Passwort Base64-codiert an den Server. Beispiel: Authorization: Basic d2lratpwzwrpyq== d2lratpwzwrpyq== ist die Base64-Codierung von wiki:pedia und steht damit für Benutzername wiki, Passwort pedia.

6 HTTP-Anfragemethoden GET POST PUT ist die gebräuchlichste Methode. Mit ihr wird eine Ressource (zum Beispiel eine Datei) unter Angabe eines URI vom Server angefordert. schickt unbegrenzte, je nach physischer Ausstattung des eingesetzten Servers, Mengen an Daten zur weiteren Verarbeitung zum Server, diese werden als Inhalt der Nachricht übertragen und können beispielsweise aus Name-Wert-Paaren bestehen, die aus einem HTML-Formular stammen. Es können so neue Ressourcen auf dem Server entstehen oder bestehende modifiziert werden. Zusätzlich können bei dieser Art der Übermittlung auch Daten wie in der GET-Methode an den URI gehängt werden. dient dazu eine Ressource (zum Beispiel eine Datei) unter Angabe des Ziel-URIs auf einen Webserver hochzuladen. Besteht unter der angegebenen Ziel-URI bereits eine Ressource, wird diese ersetzt, ansonsten neu erstellt. DELETE löscht die angegebene Ressource auf dem Server.

7 HTTP-Statuscodes 1xx Informationen Die Bearbeitung der Anfrage dauert trotz der Rückmeldung noch an. Eine solche Zwischenantwort ist manchmal notwendig, da viele Clients nach einer bestimmten Zeitspanne (Zeitüberschreitung) automatisch annehmen, dass ein Fehler bei der Übertragung oder Verarbeitung der Anfrage aufgetreten ist, und mit einer Fehlermeldung abbrechen. 2xx Erfolgreiche Operation Die Anfrage wurde bearbeitet und die Antwort wird an den Anfragesteller zurückgesendet. 3xx Umleitung Um eine erfolgreiche Bearbeitung der Anfrage sicherzustellen, sind weitere Schritte seitens des Clients erforderlich. Das ist zum Beispiel der Fall, wenn eine Webseite vom Betreiber umgestaltet wurde, so dass sich eine gewünschte Datei nun an einem anderen Platz befindet. Mit der Antwort des Servers erfährt der Client im Location-Header, wo sich die Datei jetzt befindet. 4xx Client-Fehler Bei der Bearbeitung der Anfrage ist ein Fehler aufgetreten, der im Verantwortungsbereich des Clients liegt. Ein 404 tritt beispielsweise ein, wenn ein Dokument angefragt wurde, das auf dem Server nicht existiert. Ein 403 weist den Client darauf hin, dass es ihm nicht erlaubt ist, das jeweilige Dokument abzurufen. Es kann sich zum Beispiel um ein vertrauliches oder nur per HTTPS zugängliches Dokument handeln. 5xx Server-Fehler Es ist ein Fehler aufgetreten, dessen Ursache beim Server liegt. Zum Beispiel bedeutet 501, dass der Server nicht über die erforderlichen Funktionen (das heißt zum Beispiel Programme oder andere Dateien) verfügt, um die Anfrage zu bearbeiten.

8 WebServices in Switch einbinden 3 Arten der Einbindung möglich: Flow Element HTTP-Anforderung Flow Element Befehl ausführen in Verbindung mit curl Switch Scripte/Apps/Konfiguratoren, welche Die HTTP-Klasse der Switch Scripting-API nutzen (verfügbar seit Switch 12) Oder curl als externen Prozess ansteuern Oder spezielle WebService Flow-Elemente wie z.b. WeTransfer, DropBox

9 Beispiel QR-Codes Bestandteil der Google APIs Basis URL: Query-Parameter (nach dem? ): cht=qr * chs=<breite>x<höhe> * chl=<data> * Daten müssen UTF-8 URL-encoded sein choe=<ausgabe-kodierung> UTF-8 [Standard] Shift_JIS ISO

10 curl curl (Client für URLs oder Curl URL Request Library) Kommandozeilen-Tool für diverse Plattformen Unterstützte Protokolle: HTTP, HTTPS, FTP, FTPS, DICT, LDAP, RTMP und Gopher

11 curl curl --output "/Users/shared/my_qr_code.png" " chart?cht=qr&chs=128x128&chl=

12 Switch Befehl ausführen Setzt aktiviertes Konfigurator-Modul voraus! Parameter-Definition: --output "%2" -G " --data "cht=qr" --data "chs=128x128 --data-urlencode "chl= c=detail&prnr=1255 Optionaler Einsatz von Switch (Metadata- oder Database-) Variablen

13 Switch Skriptelement Setzt aktiviertes Scripting-Modul voraus! Erlaubt komfortable Parametrisierung selbst komplexer CLIs bei vollständiger Abschottung der dahintersteckenden Aufruf-Komplexität Optionaler Einsatz von Switch (Metadata- oder Database-) Variablen

14 Cloud-Lösungen WeTransfer App (im Enfocus Appstore) oder als Konfigurator (Impressed) DropBox Upload und Download Konfiguratoren (Impressed) TeamBeam Upload Konfigurator (Impressed)

15 Anbindung an Cloud-Lösungen WeTransfer App (im Enfocus Appstore) oder als Konfigurator (Impressed) DropBox Upload und Download Konfiguratoren (Impressed) TeamBeam Upload Konfigurator (Impressed)

16 Switch als WebService Impressed hat bereits in diversen Switch-Projekten spezielle Skriptelemente im Einsatz, die eine Ansteuerung von Switch als WebService erlauben WebSocket Client Empfängt Push-Messages via WebSocket WebServer Empfängt und verarbeitet beliebige GET- und POST-Requests via HTTP/HTTPS-Protokoll Sprechen Sie uns bei Interesse auf dieses Thema an

17 Fragen?