Authentication
Authentication API allows you to log in with a user’s email address and password. The user may be either a member of your account or your customer’s account. For customers posting jobs via Applicant Tracking System (ATS), the caller is ATS and the user belongs to the customer’s account. A session token is returned after a successful login and is required to verify authorization when calling other services. The session token expires after eight hours. If the user is a member of multiple accounts, the account must be specified in the login call or the login will fail.
Tip
There are two types of user accounts: Administrator (superuser with all system privileges) and Recruiter (with limited privileges). Use Recruiter type user account with permission to post a job.
URI
https://hj.yahooapis.com/v1/HJAuthTokens
HTTP Method
POST
Parameters
The following table lists the authentication parameters required for this API:
Table 1. Authentication Parameters
| Name | Type | Required? | Description |
|---|---|---|---|
| Login | String | Y | User's email address. Max Length: 225 |
| Password | String | Y | User's password. Max Length: 6-16 |
| Version | String | Y | This field has a fixed value - 3.0 |
| License Key | String | Y | Yahoo! HotJobs Web service license key. To get your Yahoo! HotJobs Web services license key, send email to postapi@yahoo-inc.com. |
| ID | String | Y | This is the Account ID. It is required if the user is a member of multiple accounts. This ID can be obtained from YRC > Accounts Tab > Company Account > Account ID field |
Request XML Sample
The following is a sample authentication request for this API:
Success Response XML Sample
The following is a sample authentication response for this API.
Error Response XML Sample
The following is a sample authentication error response for this API: