Skip to main content

REST API Guide

400_2x.png

Overview

The Varicent Incentives APIs allow you to develop integrated applications.

This guide will take you through a few of our API's and how to use them.

The API allows Varicent Incentives modules to be available or linked into an existing program to complete the required tasks. The API uses HTTP verbs and a RESTful endpoint structure. Request and response payloads are formatted as JSON.

This API section provides an interoperable option to users who want to access Varicent Incentives in a programmatic way. Some common uses include these scenarios:

  • Client organizations that want to retrieve calculated or statistical data from Varicent Incentives for use in other downstream applications, such as portal applications, reporting, and other systems.

  • Client organizations that want to leverage web services to tightly integrate systems.

  • Client organizations that want to programmatically trigger Varicent Incentives with existing third-party scheduling or application management software.

  • Partner organizations that want to integrate their solution more closely with Varicent Incentives.

The previous scenarios involve querying Varicent Incentives, retrieving data from the system, updating data within the system, and adding data to the system.