API

API integration is a great way when you wish to fetch certain information or push certain information into the system.


To execute each API, you must have the valid access token. To get your token, you can click on the “Admin” option on the left menu and click on “System Configuration”.

 

Navigation Link : https://app.ismartrecruit.com/admin

 

 



 

On the left side click on the “External API Integration” option. If the token is blank, you can regenerate the token using the refresh button on the top side.

 

 

 

 

Job API

This API will be used to fetch the active jobs from the system. 

API Link

&city=&country=&jobCategory=&start=&numOfRecords=">https://app.ismartrecruit.com/WebsiteJSONAPI?apiKey=&jobTitle=&city=&country=&jobCategory=&start=&numOfRecords=

 

Parameters

  • : put API key in place of . [Mandatory]

  • : To fetch the jobs based on city name, put city name in place of

  • : To fetch the jobs based on job name, put job name in place of

  • : To fetch the jobs based on country name, put country name in place of

  • : To fetch the jobs based on job category name, put job category name in place of

 

User can put , , or all 

Parameters in URL.              

  • : Start Index is used to start fetching job records from the particular index.

  • : the total number of job records to be fetched.

 

Job Count API

This API will be used to fetch the active jobs count from the system. 

API Link

&[ city= | country= | jobCategory=]">https://app.ismartrecruit.com/WebsiteCountJSONAPI?apiKey=&[ jobTitle= | city= | country= | jobCategory=]

 

Parameters

  • : put API key in place of . [Mandatory]

  • : To fetch the jobs based on city name, put city name in place of

  • : To fetch the jobs based on job name, put job name in place of

  • : To fetch the jobs based on country name, put country name in place of

  • : To fetch the jobs based on job category name, put job category name in place of

 

Users can put either city= or country= or job Category= as parameters. NOT ALL THE PARAMETER in the URL.

 

View Job Detail API

This API will be used to fetch the particular job detail based on job id.

 

API Link :

&jobId=">https://app.ismartrecruit.com/WebsiteViewDlgAPI?apiKey=&jobId=

 

Parameters

  • : put API key in place of . [Mandatory]

  • : To fetch the particular job detail, put the job id in place of . [Mandatory]

 

Job Count Groupwise API

 

This API will be used to fetch the count of jobs on column wise data.

API Link

&column=&websitePublish=">https://app.ismartrecruit.com/WebsiteSearchJobAPI?apiKey=&column=&websitePublish=

 

Parameters

  • : put API key in place of . [Mandatory]

  • >: To fetch the job detail of the particular column, put the column name in place of . 

 

For Ex : jobId, job Title, etc. [Mandatory]

 

 

Search Candidate API

This API will be used to fetch a list of candidates whose status are updated between given dates.

API Link

&fromDate=&toDate=&status=&start=&numOfRecords=">https://app.ismartrecruit.com/WebsiteSearchCndAPI?apiKey=&fromDate=&toDate=&status=&start=&numOfRecords=

 

Parameters

  • : put API key in place of

  • : To insert from date of candidates.  Date format is YYYY-MM-DD.

  • : To insert to date of candidates. Date format is YYYY-MM-DD.

  • : To fetch the list of the candidates with a particular status. Available status is below.

    • ASSIGNED

    • INTERNAL_SUBMISSION

    • CLIENT_SUBMISSION

    • CLIENT_INTERVIEW

    • OFFERED

    • JOINED

    • APPLY

    • REJECTED

  • : Start Index is used to start fetching job records from a particular index.

  • : the total number of job records to be fetched.

 

Note: fromDate, toDate and num of Records are mandatory fields. And you can’t fetch more than 100 records.

 

 

Save Candidate Detail API

This API will be used to save the candidate details and set the following API link in your form action attribute.

 

<form action = ”https://app.ismartrecruit.com/WebsiteSaveCndAPI?apiKey=

Parameters

  • : put API key in place of  

  • Send a duplicateCheck Parameter with value “Y” if you want to restrict the duplicate candidate entry. 

  • Send gdprStatus Parameter with value “Y” if you want to set consent of the candidate as yes. By default it will be set as yes if GDPR setting is set as YES in your system configuration.   

 

To save the candidate details please set the following fields.

 

Fields while saving the candidate information via Save Candidate Detail API.

 

 

Fields

KEY(name parameter value in form)

VALUE

REQUIRED

Job ID

jobId

long

-

Candidate Name

cnd Name

String

Yes

Current Location

current Location

String

no

Mail

email

String

no

Birthdate

dob (Date format – yyyy-MM-dd)

String

no

Mobile

mobile

String

no

Total Experience

totalExerience

String

no

Qualification

qualification

String

no

Skills

key Skills

String

no

Nationality

nationality

String

no

Zip

zip

String

no

Linkedin

linkedin

String

no

Twitter

twitter

String

no

Skype

skype

String

no

Facebook

facebook

String

no

Gender

Gender (value should be matched with Catalog’s GENDER group)

String

no

coverLetter

coverLetter

String

no

File Text

fileText

String

no

File(Resume)

file

File(doc,pdf,txt,rtf)

no

File Name

fileName

String

no

GDPR Date

gdprDate (Date format – yyyy-MM-dd)

String

no