1. Allmoxy
  2. API/Database

Generate and Edit Access Keys

Creating User Access Keys

Access keys are a type of credential used to authenticate API requests and grant access to the API's resources and data. They are used with the Client ID and Secret Key to identify the user or application making the API request uniquely. The intended use of access keys is to ensure that only authorized users or applications are able to access and modify data through the API. By requiring access keys for authentication, you control access to your company's resources and data and monitor and audit API requests for security and compliance purposes. 

To give access to your APIs: You will go to the user you're giving access to Contact > Edit > scroll down to API Access > Create Key. From here, you can give each access key a unique name for internal reference and select only the information you would like to share with them to Create, Read, Update, or Delete given information. After settings are picked, select Create Key. 
You can now share the API Access Key, Client ID, and Secret Key with the contact. 

image.thumb.png.9321f2fd9e770e541fb8c05c6a85eb21.pngimage.thumb.png.c2dc1b91d90066e688e26eea48dd5935.png


Editing and Disabling Access Keys

If you need to change permissions on an Access key, you can easily do so by selecting the Edit Permissions button on the affiliated key. When making changes, you will have multiple save options. Use accordingly:
Save Key - Editing permissions to key with the same purpose
Generate New Key - If purpose and permissions are changing from the existing key
Disable Key - API work has been done, but you no longer want access granted with that key
Remove Key - The key was never used and is no longer needed