Skip to main content
Feature Sheet

Oleeo API

  • March 4, 2025
  • 0 replies
  • 138 views
Oleeo API

WHAT IS API?


API stands for Application Programming Interface. It is a set of rules that allows one software application to interact with another.

 

WHAT DOES IT DO?


  • APIs facilitate the integration of different systems, enabling them to communicate and share data seamlessly. 
  • In the context of Oleeo, the API allows developers to interact with the Oleeo platform programmatically, opening up various possibilities for customisation and automation

​​​

HOW DOES IT WORK?


Adding / Extracting / Amending Information

  • With Oleeo's REST API and Assessment API, your developers can programmatically add, extract, and amend recruitment-related data. 
  • This means you have the flexibility to automate processes like uploading candidate information, extracting analytics, or updating job postings directly from your existing systems. This streamlines your workflow and ensures data consistency across platforms.

Webhook for Push Notifications

  • Oleeo's REST API supports webhooks, which act as real-time push notifications. Instead of constantly polling for updates, a webhook allows your system to be notified instantly when specific events occur in Oleeo's platform. 
  • For example, you can set up a webhook to receive notifications when a candidate applies for a job, a new vacancy is created, or an interview is scheduled. This ensures that your team stays informed and can take immediate action.

Process API for Data Exchange

  • The Process API is a powerful feature built into the vacancy or application process. It enables the seamless exchange of data between Oleeo and your systems through your own API endpoint. This bidirectional communication ensures that data is synchronised in real-time. 
  • For instance, when a candidate reaches a certain stage in the recruitment process, the Process API can trigger actions in your system, such as updating the candidate's status or sending automated emails.

 

CONSIDERATIONS 


  • Complexity and Real-time Needs: If real-time data updates and more complex interactions are required, API integration might be preferred.
     
  • Batch Processing and Frequency: If periodic, batch processing is acceptable, and frequent real-time updates are not crucial, flat file integration may be suitable.
     
  • Security: Both methods need to ensure data security, but the mechanism for securing data during transfer differs. 
    • Flat File - SFTP, SSH key, IP address whitelisting, Basic auth, PGP encryption. 
    • API - HTTPS, IP address whitelisting, Basic auth

Ultimately, the choice between flat file transfer and API integration depends on your specific needs, data volume, and the level of real-time interaction required in your recruitment processes.

 

NEXT STEPS


Speak to your Commercial or Customer Success Manager for any additional information.

 

COSTS


Please speak to your Commercial or Customer Success Manager for further information.  

 

 

ADDITIONAL INFORMATION

 

 

Find out more information on our developer portal here: https://developer.oleeo.io/

Check out our Reasonable Use policy here: https://developer.oleeo.io/docs/reasonable-use/

 

 

This topic has been closed for replies.