API - Auto-LogOn-URL

API - Auto-LogOn-URL

The Auto-LogOn-URL is provided to applicants (on the applicant portal) and contacts (on the customer portal) to automatically log in at their portal. The Auto-LogOn-URL can be used in several mail templates in the eRecruiter web-application and is automatically generated within the eRecruiter backend as URL.
Structure of Auto-LogOn-URL for all portals 
{portalUrl}/Home/LogOn/{userId}?key={generatedLogonKey}
  1. portalUrl: The base-URL of the portal (applicant or customer portal)
  2. userId: ID of the user who shall be authenticated
  3. generatedLogonKey: logon key generated from user's hashed password and the expiration date of the logon key
The generated logon key of the Auto-LogOn-URL is valid for the current ongoing and the upcoming month since its generation. The key becomes invalid if the username or password of the applicant or contact changes since the LogOn-Keys are not saved but generated on each request.
To authenticate applicants through the API on a portal, there is one API endpoint:
Check if an applicant has a valid Auto-LogOn-URL 
GET Api/Applicant/{applicantId}?token={token} 
  1. applicantId: ID of requested applicant (number), userId from the Auto-LogOn-URL
  2. token: generated logon key from the Auto-LogOn-URL
Call the API endpoint using the userId and generated Logon-Key to retrieve an existing applicant. If an applicant is returned, the token is validated as valid and you can authenticate them in your applicant portal.

    • Related Articles

    • API - Applicant

      Prerequisites It's required to be authenticated to use the following methods. Furthermore, an API token with "Applicants" access level is mandatory. Applicant profile Essentially an applicant profile consists of basic  claim data . More Data can be ...
    • API - Application

      Prerequisites It's assumed that the requesting user is authenticated and there is an existing job on which an applicant wants to apply. The following actions could be performed for an application: Apply for an existing job Apply again for an existing ...
    • API - Reset Password

      Process The password reset process is basically devided into three parts. Step 1 - Trigger "I-Forget-My-Password"-Token First, the API has to be called ( http://api.erecruiter.net/Help/Api/POST-Api-Applicant-RequestPassword_email_url_culture ) ...
    • API - External Profiles

      There are two possible 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 ...
    • API - Company Import / Synchronize

      The XML company import is available through an endpoint on the eRecruiter API, if you have the "Companies" access level granted for your API key. General data structure One account has many locations. One location can have none, one or more contacts. ...