Manage API Keys (Generate New, Delete, Edit)
This user guide provides step-by-step instructions on how to manage API keys in your platform. API keys are used to authenticate and grant access to the API, enabling you to integrate the platform with other applications or services.
Prerequisites:
Step 1: Access API Key Management
After logging in, locate the “Account Settings” option on the left side of the interface, typically within the main menu or a collapsible sidebar, and click on it.
Next, find the “API Keys” option, usually within the “Account Settings” menu, and click on it to access the API Key Management page.
Step 2: Generate a New API Key
On the API Key Management page, you will see a list of existing API keys. To generate a new API key, click the “Generate New Key” button, usually located at the bottom right corner of the page.
A prompt will appear with the information “API Key Generated”. There is also a limit of a maximum of 5 API Keys.
For the new key, you can input the following data:
-
Key Label
-
Key Type
-
Enable hosted payments?
Check the Key Type for Sandbox or Live.
For more information, see the hosted payments developer documentation.
Step 3: Edit an API Key
If you want to edit the API Key, click on “Edit Label” next to the API key you want to modify.
You will see the “API key details” dialog box. Here you can change the Label of the API Key in the provided input field.
Once you've made the necessary changes, click the “Update API Key” button, usually located in the bottom right corner of the dialog. If you've decided not to make any changes, you can simply click the "X" button in the top right corner to close the dialog.
After clicking "Update API Key", if everything has been entered correctly, you should see an alert stating "Your API Key has been updated successfully."
Step 4: Delete an API Key
If you want to delete a key, find the “Delete Key” option next to the API key you wish to remove. Click on it to initiate the deletion process.
A prompt will appear with the warning: “Are you sure you want to delete your API Key?
If you're sure you want to delete the API key, click the “Delete API Key” button, usually a green button in the dialog. If you've changed your mind and do not want to delete the API key, click the “X” button in the top right corner to close the dialog.
After clicking the “Delete API Key” button, if everything is correct, you will see an “API Key Revoked” alert.
Step 5: Verify the Changes
After generating, editing, or deleting API keys, you should see the corresponding changes on the API Key Management page. Verify that the API keys are correctly displayed and that any new, edited, or deleted API keys are reflected in the list.
Managing your API keys effectively ensures that you maintain control over access to your platform's API, enhancing security and allowing for seamless integration with other applications or services.