Web:Kemp's API - Revision history

Jspenceratty: /* Kemp's API Roles */

2025-05-09T19:46:54Z

Kemp's API Roles

← Older revision		Revision as of 19:46, 9 May 2025
Line 62:		Line 62:
	<div class="mw-collapsible mw-collapsed">		<div class="mw-collapsible mw-collapsed">
	===== Admin =====		===== Admin =====
	Gives the user carte blanche rights to the entirety of Version 1 of the Kemp's API System. This can be dangerous and should not be assigned to any normal users.		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 =====		===== API User =====
	Gives the user rights to the "tablelist" function.		Gives the user rights to the "tablelist" function in Version 2.

	===== List Support Tables =====		===== List Support Tables =====
Line 81:		Line 81:
	===== OnlineIntakeUpdate =====		===== OnlineIntakeUpdate =====
	Gives the user rights to the "update" function.		Gives the user rights to the "update" function.

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

	</div>		</div>

Jspenceratty: /* Kemp's API Roles */

2025-05-09T19:43:10Z

Kemp's API Roles

@@ Line 61: / Line 61: @@
 ==== Kemp's API Roles ====
 <div class="mw-collapsible mw-collapsed">
 </div>

Jspenceratty at 19:31, 9 May 2025

2025-05-09T19:31:53Z

← Older revision		Revision as of 19:31, 9 May 2025
Line 56:		Line 56:

	[[File:Screenshot 2025-05-09 at 2.12.46 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.46 PM.png\|400px]]

			</div>

			==== Kemp's API Roles ====
			<div class="mw-collapsible mw-collapsed">

	</div>		</div>

Jspenceratty: /* Administration */

2025-05-09T19:31:07Z

Administration

← Older revision		Revision as of 19:31, 9 May 2025
Line 7:		Line 7:
	To administer the Kemp's API System, go to Administration → Administration Menu and search for API. Choose Kemp's API 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 ====<div class="mw-collapsible mw-collapsed">		==== Kemp's API Administration ====
			<div class="mw-collapsible mw-collapsed">
	===== API Settings Tab =====		===== API Settings Tab =====

Jspenceratty: /* Kemp's API Administration */

2025-05-09T19:30:53Z

Kemp's API Administration

← Older revision		Revision as of 19:30, 9 May 2025
Line 7:		Line 7:
	To administer the Kemp's API System, go to Administration → Administration Menu and search for API. Choose Kemp's API 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 ====		==== Kemp's API Administration ====<div class="mw-collapsible mw-collapsed">
	<div class="mw-collapsible mw-collapsed">
	===== API Settings Tab =====		===== API Settings Tab =====

Jspenceratty at 19:30, 9 May 2025

2025-05-09T19:30:29Z

← Older revision		Revision as of 19:30, 9 May 2025
Line 8:		Line 8:

	==== Kemp's API Administration ====		==== Kemp's API Administration ====
			<div class="mw-collapsible mw-collapsed">
	===== API Settings Tab =====		===== API Settings Tab =====

Line 56:		Line 56:

	[[File:Screenshot 2025-05-09 at 2.12.46 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.46 PM.png\|400px]]

			</div>

Jspenceratty at 19:29, 9 May 2025

2025-05-09T19:29:10Z

← Older revision		Revision as of 19:29, 9 May 2025
Line 9:		Line 9:
	==== Kemp's API Administration ====		==== Kemp's API Administration ====

	1) API Settings Tab		===== 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.		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.
Line 15:		Line 15:
	[[File:Screenshot 2025-05-09 at 1.17.06 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 1.17.06 PM.png\|400px]]

	2) Add New User Tab		===== Add New User Tab =====

	Add a new user by entering the username and password and clicking "Add new user".		Add a new user by entering the username and password and clicking "Add new user".
Line 21:		Line 21:
	[[File:Screenshot 2025-05-09 at 2.12.18 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.18 PM.png\|400px]]

	3) Existing Users Tab		===== 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).		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).
Line 27:		Line 27:
	[[File:Screenshot 2025-05-09 at 2.12.25 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.25 PM.png\|400px]]

	4) Assign Roles Tab		===== 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.		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.
Line 35:		Line 35:
	[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]

	5) Assign Tables/Permissions Tab		===== 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.		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.
Line 51:		Line 51:
	# Can Delete - can delete an item from the table.		# Can Delete - can delete an item from the table.

	6) Review Logs Tab		===== Review Logs Tab =====

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

	[[File:Screenshot 2025-05-09 at 2.12.46 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.46 PM.png\|400px]]

Jspenceratty at 19:27, 9 May 2025

2025-05-09T19:27:18Z

← Older revision		Revision as of 19:27, 9 May 2025
Line 31:		Line 31:
	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.		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.}}		- Note: Generally, users should not be assigned the 'Admin' role. This role has carte blanche to the entire API system.

	[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]
Line 49:		Line 49:
	# Can Insert - can add a new item to the table.		# Can Insert - can add a new item to the table.
	# Can Update - can modify an existing item in the table.		# Can Update - can modify an existing item in the table.
	# Can ~~Delegate~~		# Can Delete - can delete an item from the table.

	6) Review Logs Tab		6) Review Logs Tab

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

	[[File:Screenshot 2025-05-09 at 2.12.46 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.46 PM.png\|400px]]

Jspenceratty at 19:23, 9 May 2025

2025-05-09T19:23:06Z

← Older revision		Revision as of 19:23, 9 May 2025
Line 31:		Line 31:
	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.		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~~\|type=warn\|text=~~Generally, users should not be assigned the 'Admin' role. This role has carte blanche to the entire API system.}}		- Note: Generally, users should not be assigned the 'Admin' role. This role has carte blanche to the entire API system.}}

	[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]

Jspenceratty: /* Kemp's API Administration */

2025-05-09T19:20:39Z

Kemp's API Administration

← Older revision		Revision as of 19:20, 9 May 2025
Line 32:		Line 32:

	{{Note\|type=warn\|text=Generally, users should not be assigned the 'Admin' role. This role has carte blanche to the entire API system.}}		{{Note\|type=warn\|text=Generally, users should not be assigned the 'Admin' role. This role has carte blanche to the entire API system.}}

	~~{{Note\|text=Foo}}~~

	[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]

← Older revision		Revision as of 19:20, 9 May 2025
Line 32:		Line 32:

	{{Note\|type=warn\|text=Generally, users should not be assigned the 'Admin' role. This role has carte blanche to the entire API system.}}		{{Note\|type=warn\|text=Generally, users should not be assigned the 'Admin' role. This role has carte blanche to the entire API system.}}

	~~{{Note\|text=Foo}}~~

	[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]		[[File:Screenshot 2025-05-09 at 2.12.31 PM.png\|400px]]