Differences

This shows you the differences between two versions of the page.

--- ezeio2:userinterface:manage:groupsettings:apikeys [2021-11-18 17:43] – created andreh
+++ ezeio2:userinterface:manage:groupsettings:apikeys [2025-01-07 18:13] (current) – andreh
@@ Line 1: / Line 1: @@
 ===== Manage API keys =====
-This window is for creating API keys. Users with "Can access API keys" can create new API keys by Left-Clicking on the "+" symbol at the upper right of the window. The new key's will have a default name, expiration, key ID and key. Make the desired changes to the settings listed below and click submit. The new key and ID can be used in API calls to eze.io servers. See [[ezeio2:apiref:control|API reference]] for details.
+''Manage API keys'' can be accessed by clicking at the side bar to the right of the Group Settings screen.
-  * API key name - This name is for key management reference only, it is not used within the code of an API call.
+<WRAP center round info 60%>
+The user must have the following privileges enabled to access API key settings\\
+**Can edit group**\\
+**Can access API keys**\\
+</WRAP>
-  * Privileges - Options listed correspond to the available API calls. Select any number of privileges per key.
+API access is a paid & metered service. API calls are metered per account. The service can be added and purchased under Service Settings.
-  * Key expires - This date is typically set far into the future, but can be used for temporary calls or testing. The default setting is 1 year.
+Multiple keys can be active for the same account at the same time. All keys share the same service and are metered together against the allowed number of calls.
-  * Inherit to subgroups -
+Please see [[ezeio2:apiref:start|API reference]] for details about how to make API calls, and what API features are available.
-  * Call back URL -
+To add a new API key, click the (+) symbol in the header. The new key will be added to the list immediately.
-  * Key ID - Auto generated, cannot be changed
+Click the pencil symbol to view and edit the details. The trashbin symbol will delete the key.
-  * Key - Auto generated, cannot be changed
+Each key has the following settings:
+| API key name | A user-defined name |
+| Privileges | Enables the key for accessing the various API functions. Each key can have any combination of privileges enabled. |
+| Key expires | The key will automatically stop working at the given date. |
+| Inherit to subgroups | If checked, the key will allow access to groups below the current group. If not checked, only data in the current group can be accessed |
+| Callback URI | Some API functions will generate a call-back. If this feature is used, enter the desired URI here. |
+| Key ID | This is the first part of the credentials needed to user the API call (=username) |
+| Key | This is the second part of the credentials. (=password) |
+The Key ID and Key are auto-generated and can't be changed.