Edit API Key
Users can edit the API Key at this screen. Click on the first column of API Key Listing records in API Key page.
Users will need to enter the following details:
Field Name |
Mandatory |
Remarks |
Name |
Yes |
Name for this API Key (e.g. IMX / Customer Portal) |
API Key |
Yes |
API Key to be used to as Key for security/hashing purpose |
Description |
No |
Description of API Key |
Remarks |
No |
Remarks for API Key |
Active |
Yes |
Checkbox (Checked – Active, Not Checked – Inactive). Inactive API Key will not return any result. |
Role of API |
||
Name |
N/A |
Name of API to be given Access to |
IP |
No |
IP that can be used to call this API – this is optional field. Leave blank if don’t need system to check the API call is coming from whitelisted IP. |
Accept |
Yes |
Checked – Yes. Un-checked – No. Allow this API Key to access this API |
Require Auth Session Id |
Yes |
Checked – Yes. Un-checked – No. Requires that third party system to pass in session id. |
Click on “Save” button to save the details or click on “Cancel” button to cancel the action and return to API Key page.
Click on Delete button to delete the record.
Created with the Personal Edition of HelpNDoc: Easy EPub and documentation editor