About the Developer Portal

Oleeo Recruit’s REST API

Oleeo Recruit provides a JSON RESTful API available over HTTPS giving extensive access to the Oleeo Recruit System’s resources, returning data as JSON objects which are both human and machine readable. This document describes Oleeo’s API implementation together with how to use the Oleeo Recruit API and a few examples to add some insights into the functionality available. There’s also a quick reference section at the end for those who don’t have immediate access to the online Swagger documentation.

Development of the API is core to Oleeo’s product development strategy and all new developments are designed and built “API First’’. This means that the capability and coverage of the API is constantly being expanded as new features and end-points are made available. The online documentation is updated as soon as features are available using OpenAPI 3 standard and according to industry best practice for maintaining compatibility. The Swagger interface to the documentation allows for the API endpoints to be exercised in an interactive environment in real time against a client’s test or live environments.

To use the API you need credentials for an authorised User. You can start by interacting with the Swagger documentation and making API calls directly to try out some of the endpoints. Curl examples and authentication information is available in the documentation if you wish to start building applications to consume the endpoints. Please contact your Oleeo support contact for further assistance.

Swagger and OpenAPI 3.0

The Oleeo Recruit API uses Swagger UI for interactive API documentation based on the OpenAPI 3.0 Specification. The Swagger UI allows anyone to visualise and interact with the Oleeo Recruit API’s resources without having any of the implementation logic in place.

The OpenAPI 3.0 Specification is an API description format for REST APIs including available endpoints, operation parameters and authentication methods amongst other things. The specification is written in a format that is readable to both humans and machines.

The complete OpenAPI specification can be found on GitHub: OpenAPI 3.0 Specification Along with the Swagger documentation available with each system and this overview API document there is also a Developer Portal currently in beta which will offer further examples and help on how to get the most out of the Oleeo Recruit API.