NEWpixi* API und die Umstellung auf REST. Freitag, 3. Mai 13

Transkript

1 NEWpixi* API und die Umstellung auf REST

2 Fakten NEWpixi* API Technik REST-basierend.NET Webservice IIS Webserver Release 31. August 2013, zusammen mit dem NEWpixi* ELI Release Legacy API und erste NEWpixi* Funktionen Verfügbarkeit Neue NEWpixi* Funktionen über echtes REST Alte API-Funktionen über Legacy-Objekt im REST

3 NEWpixi* API und die Umstellung auf REST Flashback: Die SOAP-API Die REST-API Unterschiede Entwicklungsprozess Umstellung Empfehlungen

4 Die pixi* SOAP-API

5 Fakten pixi* SOAP API HTTP-basierendes SOAP SSL-verschlüsselt mit selbstsigniertem (nicht vertrauenswürdigem) Zertifikat HTTP (Basic) - Authentifizierung (keine WS-Security) Basierend auf der Microsoft SQL Server SOAP Erweiterung Wikipedia: Die Abkürzung SOAP wird offiziell seit Version 1.2 nicht mehr als Akronym gebraucht, da es erstens (subjektiv) keineswegs einfach (Simple) ist und zweitens nicht nur dem Zugriff auf Objekte (Object Access) dient.

6 Funktionsweise Anfrage Browser / Anwendung / pixi* App erfrägt Informationen SOAP-Client SOAP-Client übersetzt Anfrage in eine SOAP-Nachricht SOAP-Server SOAP-Server verarbeitet die SOAP-Nachricht und antwortet

7 Testen und Entwickeln mit der pixi* SOAP API soapui Kostenlose Open Source- Version zum Testen einzelner API Aufrufe mit Parametern SOAP-Client z.b. NuSOAP, PHP SOAP Client,.NET SOAP Client Clients zur Verwendung in einer Programmiersprache

8 Die NEWpixi * REST API

9 Fakten pixi* REST API REST-basierende XML / JSON Schnittstelle SSL-verschlüsselt mit selbstsigniertem (nicht vertrauenswürdigem) Zertifikat Authentifizierung über Token (URL-Call zur Authentifizierung) NEWpixi* Applikationen benutzten ausschließlich die neue REST- API.NET-basierender Webservice (IIS) Weiterführend: How I Explained Rest To My Wife

10 Authentifizierung Authentifitzierung über API Aufruf Anmeldung mit pixi Benutzern wir im Front-End / pixi-applikationen mit Userrechten Meldet Security-Token zurück Gültig für X Tage Token wir als Cookie automatisch gespeichert Einfaches Testen der neuen API über Browser Verwendung von direkten API Calls z.b. in AJAX Funktionen Alternativ wird der Token im HTTP Header übertragen für Benutzung in Apps oder eigenen Anwendungen

11 REST Key-Facts Basierend auf HTTP Einfach, Schnell, Klein Prinzipien: Adressierbarkeit - Jede Ressource hat einen URI - Unique Resource Identifier Beispiel: Immer dieser Lieferant, eine URL Unterschiedliche Formate JSON, XML etc - wird über HTTP Header ausgehandelt Stateless Skalierbarkeit, einfachheit. Standard HTTP Aktionen GET - Immer safe d.h. nur lesend, ändert nichts PUT idempotent mehrmals aufgerufen gibt gleiches Ergebnis wie einmal Pagination als Standard im Framework! (Maximal 1000 Datensätze)

12 Funktionsweise Anfrage Browser / Anwendung / pixi* App erfrägt Informationen via URL-Aufruf REST Webservice REST-Webservice verarbeitet die Anfrage Rückgabe als XML / JSON

13 Testen und Entwickeln mit der NEWpixi* REST API Browser Einfache GET- Aufrufe können über jeden Browser getestet werden. REST-Client Zum Testen der API auch mit erweiterten Methoden, POST, PUT etc. HTTP-Client HTTP-Clients in jeder Programmiersprac he zum Ansprechen des Webservices Diverse Extensions in den Browsern für einfaches Testen

14 Warum der Umstieg? SOAP-Endpunkte wurden in Microsoft SQL Server 2012 entfernt SOAP-Nachrichten überladen mit Schemainformationen Gleiche Code-Basis wie NEWpixi* => es werden die gleichen Funktionen wie in NEWpixi* verwendet We eat our own food (Peter Stegnar)

15 Entwicklungsprozess

16 NEWpixi* Entwicklung / API NEWpixi* Release ELI (31. August 2013) NEWpixi* API (REST-basierend) mit Legacy API pixi* SOAP API (ohne NEWpixi* neue Funktionalitäten), veraltet, sollte nicht mehr verwendet werden bzw. baldmöglichst ausgetauscht werden Ab Oktober 2014 NEWpixi* API (RESTbasierend) mit Legacy API pixi* SOAP API wird nicht mehr unterstützt Future NEWpixi* API (RESTbasierend)

17 NEWpixi* Entwicklung / API API-Aufrufe aus der pixi* SOAP API werden bis zur vollständigen Portierung von pixi* auf.net in einem Legacy-Endpunkt bereitgestellt Legacy-REST-API-Aufrufe werden einzeln mit der Einführung von deren NEWpixi* Pendant als veraltet markiert und zeitnah nicht mehr unterstützt Die SOAP-API wird mit Einführung der Legacy-API im REST-API-Endpunkt als veraltet markiert und wird nur noch ein Jahr unterstützt Die Legacy-REST-API wird ein Jahr nach Portierung aller pixi* Applikationen zu NEWpixi* nicht mehr unterstützt

18 Empfehlungen für die Entwicklung

19 Entwicklungsempfehlungen API-Aufrufe in Datenmodelle auslagern und an zentraler Stelle in der Applikation verwalten Nie direkte Aufrufe in Skripts verwenden Unit-Tests für API-Datenzugriffsmodelle erstellen, um Fehler bei einer Umstellung auf REST-Aufrufe zu erkennen und zu beheben

20 Datenmodell pixi* Datenmodell SOAP API (SOAP) Legacy- API (REST) NEWpixi* API (REST)

21 Umstellung pixi / pixi APPs Umstellung des pixi-apps-framework im Hintergrund - D.h. ab einem bestimmten Tag werden die neuen API Calls über REST zur Verfügung stehen und die alten API Calls über die REST-Legacy-API aufgerufen Erst mal keine Änderung in den Apps notwendig für bestehende Funktionalität Libraries für PHP /.NET speziell für pixi werden später zur Verfügung gestellt.

22 NEWpixi* Inhouse Server

23 NEWpixi* Inhouse Server Systemvoraussetzungen Umstellung Empfehlungen

24 Systemvoraussetzungen Hardware siehe pixi*pedia (pixi* Inhouse-Server Bedienungsanleitung) Software mind. Microsoft Windows Server 2008 R2 Standard IIS,.NET Framework 4.5 mind. Microsoft SQL Server 2008 R2 Standard Microsoft SQL Server 2012 bereits teilweise (ohne SOAP-Support) 64-bit Versionen bevorzugt

25 Umstellung auf NEWpixi* Installation von IIS Webserver,.NET-Framework Installation von NEWpixi* pixi* und NEWpixi* greifen auf dieselbe Datenbank zurück

26 Empfehlungen Microsoft OPEN Lizenzprogramm jederzeit Upgrade auf SQL Server 2012 (oder noch neuer) möglich Upgrade auf Microsoft SQL Server 2012, wenn SOAP API nicht mehr verwendet => Performancesteigerung Keine anderen Dienste auf dem pixi* Server (besonders Webdienste)