Skip to main content

Starting the REST API

After you have installed and configured the REST API, you must start it. It's a good idea to restart your computer before starting the REST API.

  1. Navigate to the directory in which you installed the REST API.

    By default, it is located here: C:\Program Files (x86)\Incentives\RestAPI.

  2. Double-click RESTAPI.exe to start the REST API.

    Notice

    Make sure to start the REST API as an administrator.

If the REST API starts successfully, you will see one of two things:

  • If you're installing a version prior to 10.1.1.99.0, you'll see a blank screen.

  • If you're installing a version after 10.1.1.99.0, you'll see some log information.

If the REST API cannot start, you will see error logs.

Troubleshooting

If you see errors in the console, it could mean the configuration files has mistakes. Double-check the files for any typos or inconsistencies.