Overview

APIs we offer for you are pulling and pushing data between our smartApps and your system. These two systems interact programmatically through these APIs.

Available endpoints can be categorized as follows:

  • Ludi Cloud API: Extract and Upload
  • smartLibrary API
  • smartPeople API
    • Users & Search
    • Posts

Each endpoint requires an API key. To create the API key, use the Ludi Cloud user interface.

Ludi Cloud API: Upload and Extract

Allows integration with the HRForecast smartApps from within the third-party systems.

Endpoints of this type are presented by the following groups:

  • Extractions
  • Data integration

Using the Extractions endpoints (Skill extraction and Job standardization) allow you to use our custom NLP and ML models to integrate with third-party tools.

Whereas the Data integration endpoint (Dropspace API for importing pipelines) implies importing data from your system to smartApps based on the automated pipelines. To this end, you need to create an API connection and then set up a pipeline based on this connection type in the Setup area of Ludi Cloud.

Data integration
NameDescriptionURL for published documentation
Dropspace API for import pipelinesAllows uploading data to smartApps when you create or update a file.https://documenter.getpostman.com/view/6872092/UVsHU7wh#ec74f6d6-41c9-4edf-b6cd-75662b289774
Extractions
NameDescriptionURL for published documentation
Skill extraction APIExtracts skills from a text.https://documenter.getpostman.com/view/6872092/UVsHU7wh#99a2eb81-5ff0-4088-8aaf-fcfa1466cdde
Job standardization APIGets a standardized job title for your raw job title.https://documenter.getpostman.com/view/6872092/UVsHU7wh#a69577c0-38d4-477d-b2ec-4a69dfea72dd

smartLibrary API

Allows accessing job and skill libraries via API keys to get the requested data.

Endpoints of this type are presented by the following groups:

  • Job library API
  • Skill library API

Using the Job library API endpoints (Job libraries, Job list, Job skills, Job search, Job browse, and Job details) imply getting the requested data about a job library.

Whereas the Skill library API endpoints (Skill libraries, Skill list, Skill search, Skill browse, and Skill details) allow you to receive the requested data about a skill library.

In Postman, jobs and skills that were disabled in libraries in smartLibrary are not returned in responses of the following API endpoints:

  • Job list
  • Job search
  • Job browse
  • Skill list
  • Skill search
  • Skill browse

With that, when creating and sending requests via Postman for the such API  endpoints as Job list and Skill list,  you can additionally define whether you want to include disabled jobs and skills to the API response or exclude them from it. To this end, use the Status parameter and define either the Enabled or the Disabled value for it respectively.

Job library API
NameDescriptionURL for published documentation
Job librariesReturns the following information about a job library: its ID, name in all available languages, and creation date.https://documenter.getpostman.com/view/21710440/UzJHRxwY#33cf4218-1b54-4a10-aa0f-8a82b8d0806d
Job listReturns the following information about each job of the specific library in the specific language, and of the specific status: job ID, job name, as well as job taxonomy names and levels.https://documenter.getpostman.com/view/21710440/UzJHRxwY#fd1965b5-d75e-4d3e-b741-5a5abf69d406
Job skillsReturns the following information about each skill of the specific job in the specific language: skill ID, skill name, proficiency level, as well as if the skill is mandatory or not.https://documenter.getpostman.com/view/21710440/UzJHRxwY#083b0378-a37a-4faa-ab11-a268292a8137
Job searchReturns the following information about a job of the specific job library in the specific language: job ID and job name. Depending on the text key value (meaning a search query), information about more than one job can be returned. All the jobs matching the search query are listed in the response area.https://documenter.getpostman.com/view/21710440/UzJHRxwY#b8b3c8c8-fdbd-4bf5-bc36-486e55736457
Job browseReturns the following information about a job taxonomy of a specific job library in the specific language: name and ID. It is possible to browse more than one job library. To this end, define IDs for all job libraries which you want to browse. To this end, include all IDs in square brackets. With that, put each ID in double quotation marks and separate them by commas. The parent ID key is optional.https://documenter.getpostman.com/view/21710440/UzJHRxwY#db941ec7-3b46-461f-9d1c-28e3f9cdcbbf
Job detailsReturns the following information about a specific job (by job ID), its future or current job profile in the specific language: job description, duties, future importance, seniority level, as well as job skills (skill ID, skill name, its proficiency level, and mandatory requirements).https://documenter.getpostman.com/view/21710440/UzJHRxwY#0389659b-6e46-4989-b6e5-1c6ad70a2e40
Skill library API
NameDescriptionURL for published documentation
Skill librariesReturns the following information about a skill library: its ID, name in all available languages, and creation date.https://documenter.getpostman.com/view/21710440/UzJHRxwY#3875e145-ecf9-4b07-9e61-2a3d7ee250c3
Skill listReturns the following information about each skill of the specific library in the specific language, and of the specific status: skill ID, skill name, as well as skill taxonomy names and levels.https://documenter.getpostman.com/view/21710440/UzJHRxwY#efc82168-96d5-4a28-9f14-6cc8fc7fa2ec
Skill searchReturns the following information about a skill of the specific skill library in the specific language: skill ID and skill name. Depending on the text key value (meaning a search query), information about more than one skill can be returned. All the skills matching the search query are listed in the response area.https://documenter.getpostman.com/view/21710440/UzJHRxwY#c0941ce9-1ab4-462a-a914-8946c741744a
Skill browseReturns the following information about a skill taxonomy of a specific skill library in the specific language: name and ID. It is possible to browse more than one skill library. To this end, define IDs for all skill libraries which you want to browse. To this end, include all IDs in square brackets. With that, put each ID in double quotation marks and separate them by commas. The parent ID key is optional.https://documenter.getpostman.com/view/21710440/UzJHRxwY#343976b1-40d2-4bdd-9445-12d45cde6ef6
Skill detailsReturns the following information about a specific skill (by its ID) in the specific language: its name, custom link, Wikipedia link, future importance, and its type.https://documenter.getpostman.com/view/21710440/UzJHRxwY#a986786f-d775-468b-9405-564918e2f56b

Users & Search

Allows searching for specific users, their details, as well as locations used in the system via API keys.

Endpoints of this type are presented by the following groups:

  • User search API
  • User details API
User search
NameDescriptionURL for published documentation
User searchReturns the following information about a specific user: email, first name, and last name. For private profiles, no information is returned. By sending your request in Postman to connect to the API and retrieve the requested data, you can define such details as a user’s name, user’s skills (skill IDs, mandatory requirements), or user’s jobs (job IDs), or you can even mix jobs and skills for a better fit. Specifying whether to include private profiles or not is also possible.https://documenter.getpostman.com/view/19769656/2s8ZDeTeCb#1e3fc896-6fd4-401c-827c-c4ff8badfb0c
Available user locationsReturns the following information about locations available in the system: location ID and its name. By sending your request in Postman to connect to the API and retrieve the requested data, you can define such details as URL and language ID.https://documenter.getpostman.com/view/19769656/2s8ZDeTeCb#675972eb-fd8f-48db-bd98-84b6fa658155
User details
NameDescriptionURL for published documentation
User detailsReturns the following information about a specific user:

  • Job history (returned if activated in the API configuration)
    • Job ID
    • Job type
    • Job name
  • Skill in development
    • Skill ID
    • Skill name
    • Proficiency level per skill
  • Skills (returned if activated in the API configuration)
    • Skill ID
    • Skill name
    • Proficiency level per skill
  • User’s preferred locations
    • Location ID
    • Location name
  • User details
    • User ID
    • First name
    • Last name
    • Email
    • Custom fields (returned if activated in the API configuration)
  • Trainings (returned if activated in the API configuration)
    • Training ID
    • Training name
    • Training status
    • Timestamp when the status was changed

By sending your request in Postman to connect to the API and retrieve the requested data, you can define such details as a user’s email and language ID.

https://documenter.getpostman.com/view/19769656/2s8ZDeTeCb#49ee23e1-18e0-4043-8688-e2a453a03ee4

Posts

Allows searching for specific post, it’s details and candidates via API keys.

Endpoints of this type are presented by the following groups:

  • Post details API
  • Post candidates API
NameDescriptionURL for published documentation
Post detailsReturns the following information about a specific post:

  • Post title
  • Locations
    • Location ID
    • Location name
  • Post skills (if skills are available in the post)
    • Skill name
    • Skill ID
    • Custom skill ID
    • Skill proficiency level
    • Mandatory status
  • Custom fields and entries
  • Owner username
  • Editors usernames
  • Viewers usernames
  • Date of creation
  • Expiration date
  • Type of the post (Job / Gig / Event)
  • Status of the post (Active / Archived)

By sending your request in Postman to connect to the API and retrieve the requested data, you can define such details as post ID and language ID.

https://documenter.getpostman.com/view/24887089/2sAYQUqtvw#d7742301-3cab-4758-b30d-cdaf7948b3d7
Post candidatesReturns the following information about each candidate of the post:

  • Candidate ID
  • Candidate username
  • Privacy
  • Status of candidate (New / Interested / Invited / Accepted / Declined)
  • User who changed the status for candidate
    • User ID
    • Username
  • The date when status was changed
  • Match in % (direct match)
  • Absolute match (number of skills matched)

By sending your request in Postman to connect to the API and retrieve the requested data, you can define such details as post ID and number of candidates to display.

https://documenter.getpostman.com/view/24887089/2sAYQUqtvw#d57c093d-d4df-44fb-ad10-a2f2534d0f5c

Next step

Well done! Learn more about import pipelines and continuous synchronization.