First Step – Performing Authentication

The Resumes API enables third party companies to search for resumes, look through the full resume views and download resumes at eFinancialCareers. This section will outline the procedure to authenticate to Resumes Service of eFinancialCareers.

 

You will need an email and a password for searching and viewing resumes. That data is needed to identify you in the system. If you have these then you are set to continue.

Authentication Flow

Step One – Authorization with User


To authorize, send an HTTP POST request to the following URL:

POST https://auth.ws.efinancialcareers.com/v1/authenticate HTTP/1.1

The authentication URL is different for Pilot:

POST https://auth.ws.pilot.efinancialcareers.com/v1/authenticate HTTP/1.1

Mandatory HTTP headers

Content-Type: application/xml

Authorization: EfcAuth realm="EFC"

And supply this XML representation in the HTTP request body with your credentials:

<principal xmlns="http://efinancialcareers.com/schema">
<apiKey>api_key</apiKey>
<password>password</password>
</principal>

apiKey: The API key of the user.
password: The password of the user.
 

Upon success, the server responds with HTTP 200 OK status code and an XML representation containing a token. For subsequent requests you will need to use this token so the server can identify your session. The session will expire after 30 minutes if no interaction with the server is maintained.

 

Step One – Authorization with Provider


To authorize, send an HTTP POST request to the following URL:

POST https://auth.ws.efinancialcareers.com/v1/authenticateProvider

The authentication URL is different for Pilot:

POST https://auth.ws.pilot.efinancialcareers.com/v1/authenticateProvider

Mandatory HTTP headers

Content-Type: application/xml

Authorization: EfcAuth realm="EFC"

And supply this XML representation in the HTTP request body with your credentials:

<provider xmlns="http://efinancialcareers.com/schema">
<apiKey>izpc9jhWZE5FvEUcXnePr</apiKey>
<password>z2tc-kzW5-wuC5-jF</password>
<trustedAccountApiKey>UnFRhaqi4RaGzfj9tx7Dc</trustedAccountApiKey>
</provider>

apiKey: The API key of the provider.
password: The password of the provider.

trustedAccountApiKey: The API key of the user.
 

Upon success, the server responds with HTTP 200 OK status code and an XML representation containing a token. For subsequent requests you will need to use this token so the server can identify your session. The session will expire after 30 minutes if no interaction with the server is maintained.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<token xmlns="http://efinancialcareers.com/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://efinancialcareers.com/schema https://auth.ws.efinancialcareers.com/v1/schema">
<value>522c3c4bd036a69db428ce4274745e9d</value>
</token>

Step Two


Your HTTP authorization header should contain the token received after your initial login as described in step one above.

Authorization: EfcAuth realm="EFC", token="522c3c4bd036a69db428ce4274745e9d"

Handing API errors

As the eFinancialCareers‘ API is RESTful, any HTTP status codes within the 4xx and 5xx range are classified as errors. The XML representation in the response body will help you determine the cause of each individual error that occurred. The description of the error codes can be found here.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errors xmlns="http://efinancialcareers.com/schema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://efinancialcareers.com/schema https://auth.ws.efinancialcareers.com/v1/schema">
<error errorCode="10013"><errorType>MSG_AUTH_INVALID_CREDENTIALS</errorType>
<translation lang="en">Invalid credentials</translation></error>
</errors>