Getting Started

Prerequisites

In order to use the API, you will need credentials for the system you are intending to work on, along with the system’s domain name.

Oleeo provides environments where the API documentation can be viewed and exercised for your system. These are accessed via the same subdomain as your Oleeo Recruit system. For example you would enter “mysystem” into the change system dialog if your Oleeo Recruit system was accessed by the following URL: https://mysystemname-config.tal.net

A sandpit system “developer-portal-base” is provided as default to view with swagger and try out some API calls.

Your contact at Oleeo will be able to set this up and share the details with you.

Terms used in the ATS

Candidates & Applications

It is important to note that candidates & applications are not synonymous in the ATS. Applications are made to specific vacancies and the majority of data submitted by the user will be stored at the application level for that particular vacancy. The candidate record contains information that is likely to be shared across multiple applications, such as name & email address.

Before any vacancy application is made, a user must register an account within the system if they do not have one already. At this point, a candidate record is created. Any applications made whilst logged in as this candidate will be linked to the candidate record.

A Candidate makes an Application to an Opportunity.

There are multiple types of Opportunity: Vacancy, Event, Talent Bank, Campaign

Opportunities can be advertised externally by Posting them to some marketing source.

The ATS can host multiple Job Boards and Opportunities can be Posted to these Job Boards.

Environment

Config vs Live

There are live and config versions of each environment.

Live would be for active recruitment.

Config would be for setting-up configuration and allowing testing of the configuration, using test data, before the configuration is pushed to live.

During proof of concept, Oleeo expect all work to use the Config environment however Live would need to be supported when used by Clients for active recruitment.

Examples

If you are ready to try your hand at using our API, our Examples page will walk you through some common use cases you may wish to implement.

Important Concepts

Please refer to our Extensibility page for more information on some of the intricacies of the platform.