Web:Kemp's API

Kemp's API Setup

Note: The Kemp's API system allows access to your Kemp's Prime database using an API interface. You may set the nature of the user's access to your system.

Administration

To administer the Kemp's API System, go to Administration → Administration Menu and search for API. Choose Kemp's API Administration.

Kemp's API Administration

API Settings Tab

At installation, the API Registration URL and Validation String should both have been entered for you. The "Days to Keep Log Entries" may have been entered as well. The only item you should change is the "Days to Keep Log Entries". This tells the system how long to keep log entries. Valid entries are between 1 and 365. If you wish to keep logs longer than that, you can always download the logs and save those files.

Add New User Tab

Add a new user by entering the username and password and clicking "Add new user".

Existing Users Tab

See a list of existing users. You can change the password for existing users by entering a new password and clicking "Update". You can delete a user by clicking "Delete". Please note that tokens assigned to users will continue to be honored until they expire (typically 2 hours).

Assign Roles Tab

Choose a user in the dropdown to assign roles to the user. Users must have roles assigned to use version 1 of the Kemp's API System. Available Roles are shown on the left. Assigned Roles are shown on the right. To assign a role, select it by clicking on it, then click "Assign". The role will move from the left, Available Roles, to the right, Assigned Roles. To remove a role, select it by click on it, then click "Remove". The role will move from the right to the left. As with deleting a user, tokens assigned with particular roles will continue to be honored until they expire.

- Note: Generally, users should not be assigned the 'Admin' role. This role has carte blanche to the entire API system.

Assign Tables/Permissions Tab

Version 2 of the Kemp's API System utilizes these permissions. You may choose (almost) any table in the system, and then set permissions for the user on that (those) tables.

Choose a user in the dropdown to assign tables and permissions to the user. Available tables are shown on the left. Assigned tables are shown on the right. To assign a table, select it by clicking on it, then click "Assign". The table will move from the left, Available Tables, to the right, Assigned Tables. To remove a table, select it by click on it, then click "Remove". The table will move from the right to the left. As with deleting a user, tokens assigned with particular tables and permissions will continue to be honored until they expire.

Permissions must also be granted to every assigned table. To assign permissions, click on the table in the Assigned Tables box. Once selected, a list of permissions appears to the right. Choose the permissions you wish to grant this user and click "Save Changes". Generally, the following are rights granted by each permission:

1. Can View Schema - can see the list of fields, descriptions, etc.
2. Can Lookup - can use the primary key to lookup a specific entry.
3. Can Insert - can add a new item to the table.
4. Can Update - can modify an existing item in the table.
5. Can Delete - can delete an item from the table.

Review Logs Tab

You can review or download the log entries using the "Download Logs" button.

Kemp's API Roles

Admin

Gives the user carte blanche rights to the entirety of Version 1 of the Kemp's API System and "tablelist" and "newcasenum" functions in Version 2. This can be dangerous and should not be assigned to any normal users.

API User

Gives the user rights to the "tablelist" function in Version 2.

List Support Tables

Not currently utilized in Kemp's API System.

OnlineIntake

Gives the user rights to the "schema" and "insert" functions.

OnlineIntakeLookup

Gives the user rights to the "lookup" function.

OnlineIntakeReferenceLookup

Gives the user rights to the "relatedvalues" function.

OnlineIntakeUpdate

Gives the user rights to the "update" function.

New Cases

Gives the user rights to the "newcasenum" function in Version 2.