Overview

Trackforce Valiant’s APIs are REST-based web services that exchange JSON.

REST (Representational State Transfer) exploits technology and protocols of the Web, using HTTP methods and JSON data representation to create, read, update, and delete resources. Trackforce Valiant uses REST APIs to deliver stateless, scalable interfaces that allow customers or integration partners to create and access data from Trackforce Valiant Smartforce platform near real time.

Environments

Trackforce Valiant provides two environments for each customer.

Production: live environment where all the real interaction between a customer and Smartforce platform takes place.

Sandbox/Staging: a pre-production environment that can be utilized as testing area before moving to production. Environment is prepared on need basis. Will only be available during initial testing period.

Accessing Our Services

Tokens

To access our API, you will need three types of tokens.

• Application Token (AppToken) – indicates which type of application you are accessing (TLM, Payroll, HR, etc.)
• Authentication Token (AuthToken) – grants authentication to Smartforce platform
• API Token(x-api-key) – provides access to web services with proper throttling.

Tokens for Production and Sandbox are not the same.

Request Header

Content-Type: application/json

Accept: application/json

AppToken: Your Application Token

AuthToken: Your Authentication Token

x-api-key: Your API Token

Maintenance Window

Trackforce Valiant performs routine maintenance on the platform EVERY FRIDAY MORNING BETWEEN 2:30am~5:30am

WARNING: It is advised for customers to refrain from executing any API call during our scheduled maintenance window.

Throttling

For each API, action, environments (Production/Sandbox) and API Token, the rate limit is defaulted to the values specified in the table below.

Quotas

Each account is associated with a usage plan. A usage plan represents number of request a customer can make in one month period. If you need access to higher number of requests, please contact Customer Support at support@trackforcevaliant.com.