Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 2

Please find the details below for API Integration.

OBJECTIVE
This document specifies the standard process of porting the Leads captured by the
vendor/publisher to the AIHMAS, Jaipur LMS via Lead Porting API. AIHMAS, Jaipur provides a
REST API which can be used by the vendor/publisher to Create Leads attributes in the
LMS.

CREATING LEADS
To create a new lead in the LMS, the vendor/publisher must push the following.
Parameters (mandatory), as and when a lead is captured by them.
· Name (Entered by the Lead)
· Email id (Entered by the Lead)
· Mobile Number (Entered by the Lead without country code)
· City (Candidate city)
· State (Candidate State)
· Course (Course name)
· Source (Campaign Source as captured by the Institute)
· Unique Secret Key (Provided by AIHMAS, Jaipur)
· Sample Create Request (POST)

{
[name] => applicant_name
[email] => dummy@gmail.com
[mobile] => 9999999999
[city]=>Jaipur
[state]=>Rajasthan
[course]=>candidate_course
[source] => 5pxl
[secret_key] => <Hashshared>
}

Sample Response (JSON)


{"status": "Success/Fail/Duplicate"}
NOTES:
· For all the pre-defined Data Fields i.e. name, email, mobile, course, the
Vendor/Publisher has to get the Master Data from AIHMAS, Jaipur. The same values
need to be passed in the API.
· The “Source” value will be fixed.
· While pushing the Leads, it is required that the Mandatory fields are not blank
and carry a valid value. Else, the entire Record will be failed.
· Based on the Configuration (Primary Email or Mobile or Both), the Lead will be
returned as Duplicate.
· Ideally, all the data transfers should happen on a real-time basis to facilitate
efficient lead nurturing process at the Institute end.
Parameters Value
LIVE API URL https://application.numerati.com/vendorAPI/dataporting/Careers360
secret_key 234784a12rt345f8f16a2b6c51380089xt
source Careers360
name Pranay Srivastava
email pranay.srivastava@aihmas.com
mobile 9876543210
city Jaipur
state Rajasthan
course

You might also like