Skip to main content

REST API

When you perform actions in the Incentives application, like clicking a button or exporting a file, you're really making a call using the REST API to perform those actions on the database.

During installation, you'll use Postman to make an API call to initialize the database for the first time and create at least one user.

This section will provide an overview of configuring your REST APIs with Incentives's ConfigSetter. If you wish to configure them manually, please see the Manually configuring the REST API section.

To configure the REST API using the ConfigSetter, you'll update the relevant REST API fields of these two files:

  • RESTAPI.appSettings

  • RESTAPI.dbServers

During installation, tenant services and the REST API must be on the same server. Once you have completed the installation, tenant services and the REST API can be on different servers as long as they can exchange HTTP traffic between each other.