Feedback

  • Contents
 

CIC REST Implementation

The CIC REST tools:

  • Support GET, POST, PUT, and DELETE. The tools do not support other methods.

  • Support Oauth2. The tools do not support OAuth1.

  • Provide JSON and array-parsing tools. The tools do not support other formats.

CIC provides six tools for building handlers that make requests to and consume data from RESTful APIs:

  • REST HTTP Request

  • Bearer Token Request

  • JSON Parser

  • JSON Builder

  • Array Parser

  • Array Builder

The Interaction Designer REST API Tools Developer's Guide provides examples of using these tools in handlers. For more information about the inputs, outputs, and exit paths of each tool, see the Interaction Designer Help at https://help.genesys.com/cic/mergedProjects/wh_id/desktop/hid_introduction.htm.

REST Handler best practices

  • Familiarize yourself with the API you want to communicate with. For example, some APIs receive parameters in the URL itself, while others take parameters in the header. This behavior has an impact on tool inputs.

  • Be aware of any incompatibilities between an API and the CIC REST tools. For example, these tools do not support OAuth1.

Proxy awareness

REST HTTP Request and Bearer Token Request include an optional Proxy Uri parameter where you can enter a forward proxy address for retrieving content from the API server. The parameter must include the protocol used. For example, http://proxy.example.com or http://192.168.1.10.