Dokumentation REST API Installation

Transkript

1 Dokumentation REST API Installation OCLC GmbH Betriebsstätte Böhl-Iggelheim Am Bahnhofsplatz Böhl-Iggelheim bibliotheca@oclc.org Tel. +49-(0) Internet: Fax +49-(0)

2 Impressum Titel Hersteller, Ort OPEN REST API Installation OCLC GmbH, Betriebsstätte Böhl-Iggelheim Gültigkeit OPEN REST API Installation Auflage November 2014 Dokumentnummer OCLC GmbH, Grünwalder Weg 28g, Oberhaching Alle Rechte vorbehalten. Hinsichtlich der Nutzung dieses Handbuchs sowie der darin beschriebenen Software gelten die Allgemeinen Geschäftsbedingungen von OCLC. Soweit die Programme einzelne sog. Open-Source-Komponenten enthalten, unterliegen diese Programme bzw. Programmteile vorrangig den jeweiligen Open-Source- Lizenzbedingungen, insbesondere werden dem Kunden die dort genannten Nutzungsrechte eingeräumt. Der Kunde darf dieses Handbuch nur für interne Zwecke verwenden und dieses nur im Rahmen des eigenen zulässigen Gebrauchs vervielfältigen. Jegliche darüber hinausgehende Nutzung ist ohne vorherige ausdrückliche Zustimmung von OCLC ausdrücklich untersagt. Der Kunde darf dieses Handbuch insbesondere nicht unerlaubt vervielfältigen, übersetzen, ändern oder erweitern oder davon abgeleitete Werke erstellen. Dieses Handbuch dient ausschließlich Informationszwecken und kann von OCLC ohne Vorankündigung jederzeit verändert bzw. an die aktuellen Entwicklungen angepasst werden. Die in den Beispielen verwendeten Namen und Daten sind frei erfunden, soweit nichts anderes angegeben ist. 2

3 Inhalt Allgemeines... 4 Voraussetzungen... 5 Installation... 6 Zertifikat einbinden

4 Allgemeines Diese Anleitung beschreibt, wie der REST API Webservice wird, damit BIBLIOTHECAplus- Kunden Ihren Leserinnen und Lesern individuelle APPs mit folgenden Funktionen bereitstellen können: Recherche und Detailanzeige von Medien, Anmeldung eines Bibliotheksnutzers, Leserkonto, Services (Verlängern und Vorbestellen von Medien/Exemplaren, Vorbestellungen löschen). 4

5 Voraussetzungen Sie müssen die Installation mit einem Windows-Benutzer durchführen, der über Administratorrechte verfügt. Es muss das.net Framework 4.0 installiert sein. 5

6 Installation 1. Öffnen Sie die Datei Setup.exe. Das Fenster OCLC OPEN API-Setup erscheint. 2. Wählen Sie das Installationsverzeichnis. 3. Klicken Sie auf Weiter. 4. Geben Sie die Verbindungsdaten zu Ihrer OPEN COP Installation ein. Hinweis: Sie können diese Daten in OPEN im Modul OPEN.CopConnector unter Auflistung vorhandener Dienste nachlesen. 5. Klicken Sie auf Weiter. Die Einstellungen werden überprüft. 6. Wählen Sie einen Namen für die API-Website aus. Über diesen Namen finden Sie die Website im IIS. 7. Klicken Sie auf Weiter. Die Installation wird vorgenommen. 8. Notieren Sie Ihren APIKey. Dieser muss bei jeder Anfrage an die API mitgeliefert werden. Das Verfahren stellt sicher, dass die Schnittstelle nicht von jedem benutzt werden kann. 9. Öffnen Sie im IIS Ihre API-Website und weisen Sie der HTTPS-Bindung ein Zertifikat zu. Ändern Sie ggf. den Port falls dieser bereits belegt ist. Hinweis: Siehe Kapitel Zertifikat einbinden. Sie benötigen ein kostenpflichtiges Zertifikat, da der Dienst von außen aufgerufen wird und die Identität bestätigt sein muss. 10. Bitte beachten Sie, dass die Anwendung schreibenden Zugriff auf die Datei ApiKeys.xml benötigt, die sich im Installationsverzeichnis befindet. 11. Testen Sie die API durch den Aufruf der URL im Browser: Hinweis: Eine detaillierte Fehlermeldung im Falle eines Fehlers sehen Sie nicht im Internet Explorer. 6

7 Falls Sie den APIKey nicht korrekt angeben erscheint: {"ErrorMessage":"A valid API key needs to be included using the apikey query string parameter."} Falls Sie Ihren Lizenzschlüssel nicht eingegeben haben, erscheint: {"ErrorMessage":"license check failed"} Falls alles korrekt ist, erscheint: {"ErrorMessage":"not implemented. please use child ressource [/Catalogues/{id} ] for specific catalogue information or [/Search] for searching."} 7

8 Zertifikat einbinden Für die Nutzung der API (Benutzerspezifische Aktionen) benötigen Sie ein Zertifikat. Sie benötigen ein kostenpflichtiges Zertifikat, da der Dienst von außen aufgerufen wird und die Identität bestätigt sein muss. Gehen Sie hierfür wie folgt vor: 1. Öffnen Sie die Internet Information Services (IIS) auf dem betroffenen Server. 2. Öffnen Sie den linken Baum des IIS, bis Sie Ihre API-Webseite sehen. Klicken Sie diese mit der linken Maustaste an. 3. Klicken Sie im rechten Fensterbereich auf Bindungen. 4. Klicken Sie auf Hinzufügen. 5. Machen Sie Ihre Angaben zu IP-Adresse (falls relevant) und Port, und wählen Sie unter SSL-Zertifikat das gekaufte Zertifikat aus. Hinweis: Achten Sie darauf, dass Sie keine Ports doppelt belegen. Verwenden Sie z. B. den Port