{"id":3859,"date":"2021-03-12T12:04:03","date_gmt":"2021-03-12T20:04:03","guid":{"rendered":"https:\/\/support.gwapps.com\/?post_type=ht_kb&p=3859"},"modified":"2022-06-28T15:15:05","modified_gmt":"2022-06-28T22:15:05","slug":"platform-api-keys","status":"publish","type":"ht_kb","link":"https:\/\/support.gwapps.com\/it\/knowledge-base\/platform-api-keys\/","title":{"rendered":"Piattaforma: Chiavi API"},"content":{"rendered":"\n

API keys are a simple encrypted string that can be used to generate a bearer token, that will in turn be used to call GW Apps APIs related to your domain. Make sure that you keep all your keys secure<\/em><\/strong>. Publicly exposing your credentials can result in your data being compromised.<\/p>\n\n\n\n

Platform API Keys<\/strong><\/td><\/tr>
\"Api<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Item<\/strong><\/td>Description<\/strong><\/td><\/tr>
+ Create API Key<\/td>Click on to create an API Key and select the scopes for Users and Shared roles.<\/td><\/tr>
Enabled<\/td>Allows the specific API key to be enabled or disabled. When it is disabled, requests using that key will be ignored by GW Apps.<\/td><\/tr>
\"\"<\/td>Select the three dots to view options for the selected key.<\/td><\/tr>
\"\"<\/td>– Generate New Key<\/strong> will generate a new API key. This will invalidate the prior key, so you will need to share the new key with developers of services that access this API.
– API Reference<\/strong><\/mark>will open the API documentation on how to call the RESTful API endpoints for User and Shared Role actions.
– Edit<\/strong><\/mark> opens the selected API Key configuration for editing.
– Remove<\/strong> Deletes the selected API Key configuration.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

API Key Configuration<\/h2>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Item<\/strong><\/td>Description<\/strong><\/td><\/tr>
Name<\/td>Name of the API Key.<\/td><\/tr>
Description<\/td>[Optional] Description of the API Key.<\/td><\/tr>
Security Details<\/strong><\/td><\/td><\/tr>
Type<\/td>Select \u2018All domain users\u2019 to allow anybody to execute an API call, or \u2018Specific users\u2019 to allow only specific people access to the API key.<\/td><\/tr>
User email<\/td>Search email address of users within the domain to grant them access to use this API Key. (Hidden if \u2018All domain users\u2019 is selected for Type.)<\/td><\/tr>
Access Details<\/strong><\/td><\/td><\/tr>
Entities<\/td>Select ‘Users’ or ‘Shared Roles’. (When a new API Key is created, both entities are already listed under Access Details.)<\/td><\/tr>
Selection Scopes<\/td>Sets the scope or permissions allowed for the records for the selected form.

Options for ‘Users’ are:
\u2013 Create User
\u2013 Suspend User
\u2013 Activate User
\u2013 View and Search Users
\u2013 Export Records to PDF
\u2013 View Form

Options for ‘Shared Roles’ are:
\u2013 Create Shared Role
\u2013 Update Shared Role
\u2013 Delete Shared Role
\u2013 View and Search Shared Roles
\u2013 Add User to Shared Role
\u2013 Remove User from Shared Role

(When a new API Key is created, each entity will have all Scopes enabled. You can deselect Scopes to disable the permission,)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

API Key Configuration Best Practices<\/h2>\n\n\n\n

API keys are a simple encrypted string that can be used to generate a bearer token, that will in turn be used to call your GW Apps APIs. Make sure to keep all your API keys secure. Publicly exposing your credentials can result in your data being compromised.<\/p>\n\n\n\n

While generating your API Keys, keep the following suggestions in mind:<\/p>\n\n\n\n