[ CATS Developer Forum ] [ Frequently Asked Questions ]

API Functions

	Function
	add_activity
	add_attachment
	add_candidate
	add_company
	add_contact
	add_email_activity
	add_joborder
	add_pipeline
	candidate_login
	delete_candidate
	delete_company
	delete_contact
	delete_joborder
	get_activities
	get_applicants
	get_attachment
	get_attachments
	get_backup
	get_candidate
	get_candidates
	get_companies
	get_company
	get_company_select
	get_contact
	get_contacts
	get_joborder
	get_joborders
	get_lists
	get_pipelines
	get_public_joborders
	get_resume
	get_statuses
	get_tasks
	publish
	register_client
	search
	set_status
	update_attachment
	update_candidate
	update_company
	update_contact
	update_joborder

Our API (Application Programming Interface) provides a way for you to access CATS features and functions without actually logging in and clicking the links using a web browser. This opens the door for you to communicate with CATS and manipulate your data from your web site, a software application, or a mobile device.

API requests are sent over HTTP 1.1 following the principles of RESTful design. This means that you can communicate with our API using just about any programming language or platform with minimal effort. You can even manipulate our API without a programming language simply by typing a URL string into your browser's location bar.

API requests do not use your CATS username and password. Instead, they use a transaction key. There is little difference between a CATS user and a CATS API user. When the CATS API performs an action such as adding a record, the notes explaining who performed that action will be linked to user performing the action. Most user permissions work the same with exception to "Read Only", read only users are not allowed to access API functions.

The only thing functionally different between the API and a regular user is how you access the system. The CATS API doesn't have a username and password like a regular user does. Instead, transaction codes are generated by the site administrator which serve as a password along with the company ID which serves as a username. Transaction codes should be kept secret!

The reason a "transaction code" is used instead of a password, is because the transaction code is kept in plain text on your web server. If your web server is ever intruded or "hacked", the intruder wouldn't be able to login into your CATS system, they would only have access to API functions. Transaction codes can be deleted or changed without affecting your regular username or password.

To create a new transaction code, log into CATS. Click on the "Settings" tab, then "Administration" (in the blue bar) and finally "User Management". The second section named "Web Services (API)" contains all the transaction codes you currenly have issued. You can delete codes, or select a user from the drop down box and select "Generate New Tranaction Code" to issue a new code.

A professional subscription and a transaction code are required to access our API.