Installation (REST API for Conigma CCM)

Technical requirements

To use the REST API, a Conigma installation is required, which contains at least one SAP system with base release 7.50 or higher. This system must be accessible via HTTP or HTTPS to use the API.

Import

If the REST API has not already been provided as part of the Conigma delivery, it will be provided as a separate ZIP archive. Besides the required transport requests, this archive contains a file named "ReadMe_EN.txt" with information about the request numbers (TRKORRs) and contents.

Transfer the datafile and the cofile to the appropriate transport directories and import them into the main client of the system (the client that is to take over communication with the connect server) using transaction STMS.

All delivered objects are using the namespace /GAL/ and are associated with different packages in the same namespace.

For more information about importing transport requests and transaction STMS, see the relevant Netweaver Application Server documentation.

Activation of the web service

After the import, the service needs to be activated. To do this, call transaction SICF.

Press F8 or click on "Run". Now navigate to the service /default_host/gal/conigma/ccm/api/rest/1 and activate it via the context menu.

Confirm the activation in the following popup by clicking the "Yes" button, where a hierarchy symbol is displayed on the left. This will also activate all required parent services.

Testing the web service

To test access to the REST API, select “Test Service” from the context menu of the ICF node /gal/conigma/ccm/api/rest/1.

Depending on the SAPgui configuration, a window with a security warning may appear as the SAPgui tries to open a browser window. Use the " Allow " button to continue.

A browser window then opens and prompts you for a valid SAP user and password. Ignore this prompt and click the "Cancel" button if necessary. Copy the URL from the browser and add the component "/ping" to the path (i.e. the part before the question mark). The URL should now match the following pattern: .../gal/conigma/ccm/api/rest/1/ping?sap-client=...

Copy the path to the clipboard and log on to the system which should access the API. The procedure for testing access to the REST API differs depending on the technical capabilities of the system.

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-based systems without GUI

Enter the following command line and replace the values in the curly brackets with the desired values:

If the output is a JSON document with the following structure, the test was successful.

Windows based systems without GUI with .NET Core based PowerShell (version 7 or newer)

Enter the following command line in a PowerShell and replace the values in the curly brackets with the desired values:

You are now prompted to enter a valid SAP user and password.