There are two possible cases of integration of third party profiles in your applicant portal. The first is to let applicants login/register to your portal with an external profile and the latter is to just link external profiles to the applicant's profile.
Prerequisites for Login
If you want to include the authentication via external profiles like XING or LinkedIn in your applicant portal and want to use the support of the eRecruiter API then you have to consider following prerequisites.
In the eRecruiter administration area:
- Go to your applicant portals and create one if none exists.
- Go to the applicant portal settings of the portal you want to use and go to the Third party profiles section.
- Provide the consumer keys and secrets for XING and/or LinkedIn
You find these keys and secrets in the "PortalSettings" property of the mandator response (GET Api/Mandator) for use in your applicant portal.ways for external profiles to be integrated into an applicant portal:
- Login with external profile
- Link with external profile
Login with external profile
Prerequisites
The following prerequisites need to be met, if authentication via external profiles should be supported through the eRecruiter API.
- In the eRecruiter application an applicant portal needs to be created if it does not exist.
- In the eRecruiter application the OAuth consumer keys and secrets need to be provided for an applicant portal.
The configuration information is part PortalSettings
object in the API mandator response (http://api.erecruiter.net/Help/Api/GET-Api-Mandator)
Login with external profile
You have the possibility to let applicants login to your applicant portal via an external profile. The authentication with the external profile platform must be handled by yourself. We offer an open source library for connecting to XING and LinkedIn for the .NET platform, which we use in our applicant portal (https://github.com/eRecruiter/eRecruiter.SocialConnector).
...
- Authorize with third party to retrieve the external profile identifier.
Use the following request to with the retrieved external profile identifier for either XING or LinkedIn
Code Block title Get an applicant by their third party identifier GET Api/Applicant?identifier={identifier}&thirdParty={thirdParty}
The request checks if the applicant profile already exists in the eRecruiter and returns the profile if found.
- If the profile was found you can successfully authenticate the applicant in your applicant portal.
Link
...
External profiles like XING or LinkedIn can be linked or unlinked with your applicant profile. The only important prerequisite is an existing applicant profile in the eRecruiter.
Link
with external profiles
Two parameters are mandatory for linking the external profiles to your applicant profile:
...
After the applicant has been authenticated with the external platform the basic data of the external profile has to be fetched.
Use the resource GET https://api.xing.com/v1/users/me (Further information) to to retrieve the basic user profileprofile (see XING User Profile).
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
"users": [ { "id": "123456_abcdef", "first_name": "Max", "last_name": "Mustermann", "permalink": "https://www.xing.com/profile/Max_Mustermann" } ] |
...
Code Block | ||
---|---|---|
| ||
POST Api/Applicant/Xing/{applicantId}?identifier={identifier}&profileUrl={profileUrl} |
Use the The resource https://api.linkedin.com/v1/people/~:(id,first-name,last-name,public-profile-url)?format=json (Further information) can be used to retrieve the basic user profile .(see Sign-In with LinkedIn)
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "id": "1R2RtA", "firstName": "Frodo", "lastName": "Baggins", "public-profile-url": "http://www.linkedin.com/pub/frodo-baggins/..." } |
To link your an applicant profile the properties "id" as identifier and the "public-profile-url" as profileUrl external profile identifier (identifier
) and the URL to the external profile (profileUrl
) are required for the resource below.
Code Block | ||
---|---|---|
| ||
POST Api/Applicant/LinkedIn/{applicantId}?identifier={identifier}&profileUrl={profileUrl} |
Unlink
If you want remove the the XING or LinkedIn connection , you just have to unlink the applicants with the following resourcesshould be removed the following to endpoints can be used.
Code Block | ||
---|---|---|
| ||
DELETE Api/Applicant/Xing/{applicantId} DELETE Api/Applicant/LinkedIn/{applicantId} |
Fill applicant's profile with data from the external profile
This is a recommendation on how to fill the applicant's profile with the data from the external profile. Our applicant portal maps the third party information to the eRecruiter entities as seen in the table below. As some entities in the eRecruiter require some properties, we describe how we managed the mapping from the third party profile to the applicant's profile.
...