Welcome to Troops' platform integration API documentation!
The API provides an open integration with Troops SaaS HR platform for its customers
The API is organized around REST. It allows you to create or manipulate some resources within your Temporary Employment Agencies(TEA) group, such as:
- Create candidates and their related assets like availabilities, interviews
- Browse your agencies structure and its employees
- Query references information
- Create Paychecks
- Manage your payroll engine bookkeeping variables
- Remotely accept or reject a proposed mission for a certain candidate
Authentication
The entire API is authenticated, so to use it you will require an API key. To
acquire one, please send a request to your account manager at Troops or to
[email protected].
When making requests, you need to specify the API key using the Bearer scheme in
the Authorizatoin header, e.g. Authorization: Bearer this-is-my-secret-token.
Your API keys carry many privileges, so be sure to keep them secure! Do not
share your secret API keys in publicly accessible areas such as GitHub,
client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
API requests without authentication will also fail.
Flexible References
Some endpoints accept references to candidates in a flexible fashion, allowing
you to uniquely identify them even if you do not know their Troops UUID, e.g.
using their Evolia ID or SSN.
They can only be used when the resource can indeed be uniquely identified this
way, that is, when the scope is already that of a unique TEA, not the entire
tree.
The format is scheme:id, i.e. erp:12345 in case of an Evolia ID. The
following schemes are in use:
troops: Troops UUIDerp: Evolia IDssn: French social security number
Convention for Nested Query Parameters
Some query parameters include nested objects, like the filter in the List
Candidates endpoint. This is encoded the following way in the URL:
filters[tea_id]=abc&filters[ref][erp]=12345