REST API - Configuration in RaPTr Server

PARAMETERS

Parameter	Definition
Supervisor Hostname	The base URL which is used in outbound REST requests to customer’s supervisor REST server. Default is localhost. Note that the scheme (http vs https) will automatically be appended to this parameter based on the parameter “Use SSL” and does not need to be included in the hostname.
Use SSL	Determines whether SSL is used. If selected the scheme is changed from http to https.
REST API Local Port	The TCP port on which the customer’s Supervisor REST Client connects to RaPTr Server. Default is 52328.
REST API Supervisor Port	The TCP port on which RaPTr Server connects to the customer’s Supervisor REST server. Default is 52329. If set to 0, it will not be added to the URL when RaPTr Server calls the Supervisor.
Forward Images	Enables or disables the forwarding of images (BarcodeImageEvent, AdditionalImageEvent)
REST Username	Username for basic authentication of customer’s REST client and server.
REST Password	Password used in basic authentication of customer’s REST client and server.

RAPTR SERVER CONFIGURATION

The following section describes how to setup your RaPTr Server to use the REST-API Operational Interface. It also provides details on the implementation of the REST-API at the Supervisor.

1.        Launch RaPTr Server Utility desktop application

2.        Enter in Username and Password

3.        Select REST API from the Type drop down menu located in the Interface section. (see following page) 

4.        Update Supervisor Hostname and REST API Supervisor Port.

5.        Enter in a new REST Username and REST Password.

6.        Optionally, update the REST Client Port.

7.        Save changes and force RaPTr Server to restart.