candidate_login

(CATS API 2.0)

Validates candidate login credentials against their stored email/password values in CATS. Useful to replicate a career portal type registration system or for candidates to check the status of their jobs, apply to positions, etc.. The function will return the candidate's name, id and a "session_code" that can be safely stored in a cookie or a session and remains active for 30 minutes. This code can be used in place of the id for the update_candidate, add_pipeline, and set_status functions.


[ List of API Functions ] [ Frequently Asked Questions ]

Base URL
https://[subdomain].catsone.com/api/candidate_login
[subdomain]: This is the company ID that you created when you signed-up. It will appear on the upper left when logged into CATS.
Parameters
Note that parameters can be transmitted through the GET or POST specifications in accordance with HTTP 1.1.

Example using GET: [Base URL]?[parameter]=[value]

Required Parameter Description Type Size
YES email Candidate's email address which serves as their username. string 255
YES password Password stored in the candidate record. string 128
  hash By default, the password is transmitted plain text. If you're calling this function through the HTTPS protocol, the entire transmission will be encrypted making the lookup secure. If you're not using HTTPS or would prefer to send a one-way encrypted hash, the following options may be set:
  • md5-salt: md5 hash w/company_id salt. If your company id is 'acme', then pseudocode/SQL would be: MD5(CONCAT(company_id, MD5(password)))
  • md5: basic md5 hash with no salt
  • crc32: basic crc32 polynomial with no salt
  • sha1: basic sha1 hash with no salt
string 64
Example Form
subdomain
email

Candidate's email address which serves as their username.
password

Password stored in the candidate record.
hash

By default, the password is transmitted plain text. If you're calling this function through the HTTPS protocol, the entire transmission will be encrypted making the lookup secure. If you're not using HTTPS or would prefer to send a one-way encrypted hash, the following options may be set:
  • md5-salt: md5 hash w/company_id salt. If your company id is 'acme', then pseudocode/SQL would be: MD5(CONCAT(company_id, MD5(password)))
  • md5: basic md5 hash with no salt
  • crc32: basic crc32 polynomial with no salt
  • sha1: basic sha1 hash with no salt

Copyright ©2012 CATS Software, Inc. All rights reserved.