Installing RESTful Interfaces

Installation procedure for the RESTful Intefaces (RI) package

The RI package provides the following:

  • Operational interfaces:

    • RESTful Contact Management Interface (CMI)

      For accessing information on conversations, such as script results, chats, emails, callbacks, and call recordings that have already been saved into the database

    • RESTful Directory and Presence Interface (DPI)

      For accessing to directory data and presence information (absence and presence profiles)

    • RESTful Outbound Campaign Interface (OBI)

      For viewing, managing, and controling campaigns.

    • RESTful Task Management Interface (RTI)

      For managing tasks in Sinch Contact Pro. It corresponds to TMI but uses the restful interface and provides OAuth authentication.

  • Configuration interfaces:

    RESTful Configuration Interface (RCI)

    For accessing configuration data and configuring users, user groups, queues, queue groups roles, skills, time zones, and presence profiles

  • Monitoring and reporting interfaces:

    • RESTful Analytics Interface (RAI)

      For accessing real-time and historical statistics related to conversations and agents

    • RESTful License Reporting Interface (LRI)

      For accessing usage statistics from the contact center system for license reporting needs

    • RESTful Monitoring Interface (RMI)

      For getting information about conversations, agents, and queues from Monitoring Database. Additionally, the RMI provides uploading analytic data for SAP Cloud for Customer (C4C).

Installation Procedure

Note:

If any of the RESTful Interfaces, such as Directory and Presence Interface (DPI) is used together with ECF, the packages RI and ECF Web Server must be installed on the same server.

If communication between RI and ECF Web Server needs to be secured, you must make sure that the following conditions are fulfilled in both ECF Web Server and RI installation.:

  • Only TCP Port Number for HTTPS is defined during installation.

  • IP addresses of both ECF Web Server and RI virtual units are added as extensions to the certificate request.

  • Java trusts the certificate, or its issuer.

RESTful Interface uses Tomcat, and installing the RI package installs this to the system. You need a certificate to make the connection secure.

  1. Create a certificate, see Creating Certificate for RESTful Interfaces.

    As of version 1611, communication between RI and ECF Web Server can be secured as well. To do that, add the IP addresses of both ECF VU and RI VU to both ECF and RI certificate request extensions, and when you receive the certificate, enter it or the issuer to Java folder.

  2. Install the RI VU with IA, see Installing RESTful Virtual Unit.

  3. If you have selected Java keystore during installation, you need one, see Generating Java Keystore