Installation (REST API für Conigma CCM)

Technische Voraussetzungen

Für die Verwendung der REST API wird ein Conigma Installation benötigt, welche mindestens ein SAP-System mit Basisrelease 7.50 oder höher beinhaltet. Dieses System muss für die Verwendung der API über HTTP oder HTTPS erreichbar sein.

Import

Sofern die REST API nicht bereits als Bestandteil der Conigma-Auslieferung zur Verfügung gestellt wurde, erfolgt diese als separates ZIP-Archiv. Dieses enthält neben den benötigten Transportaufträgen eine Datei namens „ReadMe_EN.txt“ mit Angaben zur den Auftragsnummern (TRKORRs) und Inhalten.

Übertragen Sie das Datafile und das Cofile in die entsprechenden Transportverzeichnisse und importieren Sie diese mit Hilfe der Transaktion STMS in den Hauptmandant des Systems, welches die Kommunikation mit dem Connect Server übernehmen soll.

Alle ausgelieferten Objekte liegen im Namensraum /GAL/ und untergliedern sich in verschiedene Pakete.

Weitere Informationen zum Import von Transportaufträgen und der Transaktion STMS finden Sie in der entsprechenden Dokumentation des Netweaver Application Servers.

Aktivierung des Webservices

Nach dem Import muss der nun verfügbare Service aktiviert werden. Rufen Sie hierfür die Transaktion SICF auf.

Drücken Sie F8 oder klicken sie auf „Ausführen“. Navigieren Sie nun zum Service /default_host/gal/conigma/ccm/api/rest/1 und aktivieren Sie diesen über das Kontextmenü.

Bestätigen Sie die Aktivierung im folgenden Popup über die Schaltfläche „Ja“ bei der links ein Hierarchiesymbol angezeigt wird, um alle relevanten übergeordneten Services ebenfalls zu aktivieren.

Test des Webservices

Um den Zugriff auf die REST API zu testen, wählen Sie im Kontextmenü des ICF-Knotens /gal/conigma/ccm/api/rest/1 den Menüpunkt “Service testen” aus.

Je nach SAPgui-Konfiguration erscheint evtl. ein Fenster mit eine Sicherheitswarnung, da die SAPgui versucht ein Browserfenster zu öffnen. Klicken Sie hier auf “Zulassen”.

Anschließend öffnet sich ein Browserfenster und fordert Sie zur Eingabe eines gültigen SAP-Benutzers und Passworts auf. Ignorieren Sie diese Aufforderung und klicken Sie ggf. auf die Schaltfläche “Abbrechen”. Kopieren Sie dir URL aus dem Browser und ergänzen Sie den Pfad (d. h. den Teil vor dem Fragezeichen) um die Komponente “/ping”. Der URL sollte nun folgendem Muster entsprechen: …/gal/conigma/ccm/api/rest/1/ping?sap-client=…

Kopieren Sie der Pfad in dies Zwischenablage und melden Sie sich auf dem System an, welches Auf die API zugreifen soll. In Abhängigkeit von den technischen Möglichkeiten des Systems unterscheidet sich die Vorgehendweise zum Test des Zugriffs auf die REST API.

Systeme mit GUI und Browser

Besitzt das entsprechende System einen GUI und einen Browser, öffnen Sie die oben kopierte URI im Browser. Daraufhin werden Sie aufgefordert, einen gültigen SAP-Benutzer und ein Passwort einzugeben. Geben Sie die geforderten Daten ein und bestätigen Sie Ihre Eingaben. Wird im Browser nun ein JSON-Dokument angezeigt, welches von der Struktur her folgendem Beispiel entspricht, so war der Test erfolgreich.

Linux-basierte Systeme ohne GUI

Geben Sie folgende Kommandozeile ein und ersetzen Sie die Werte in den geschweiften Klammern durch die gewünschten Werte:

Wird nun ein JSON-Dokument mit folgender Struktur ausgegeben, so war der Test erfolgreich.

Windows basierte Systeme ohne GUI mit .NET Core basierter PowerShell (Version 7 oder neuer)

Geben Sie folgende Kommandozeile in einer PowerShell ein und ersetzen Sie die Werte in den geschweiften Klammern durch die gewünschten Werte:

Sie werden nun von Der PowerShell zur Eingabe eine gültigen SAP-Benutzers und dessen Passwort aufgefordert.

Wird anschließend ein JSON-Dokument mit folgender Struktur ausgegeben, so war der Test erfolgreich.

Windows basierte Systeme ohne GUI mit klassischer PowerShell