CATS API Calls

Creating an API Account and Password

There is little difference between a CATS user and a CATS API user. When the CATS API performs an action (i.e.: adding a record) the notes explaining who performed that action will be linked to a user of your choice. You may want to link the changes to an existing user, or you may want to create a new user in the system to associate all API actions with.

The only thing functionally different between the API and an actual user is how they log into the system. The CATS API doesn't enter a username and password like a regular user. Instead, you, the site administrator creates a "transaction code" which the API uses as a password behind the scenes.

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.

You can have more than one transaction code, but each code is linked to a unique user. If you have multiple websites, or need to associate API changes to different users -- this is possible.

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.