Manage App Keys (Generate New, Edit, Delete)
This user guide provides a step-by-step guide on how to manage App Keys within the platform. App keys are crucial for integrating your application with other services, so it's important to know how to generate, edit, and delete them as needed.
Prerequisites:
-
You must have administrative privileges to manage App keys.
-
Ensure that you are logged in to the platform.
Step 1: Access
After logging in, navigate to the “Account Settings” or a similar option on the left side of the interface, typically within the main menu or a collapsible sidebar, and click on it.
Locate and click on “Apps” or a similarly labeled option to access the “Apps” management page.
Step 2: Upload Logo
Before creating a new App key, you should upload your logo. This makes it easier for companies that connect with you to identify who you are. To upload a logo, click on the “Upload Logo” button.
Select the logo file from your computer and upload it. Make sure that the image is in a supported format and does not exceed the maximum file size.
Step 3: Generate a New App Key
On the Apps Management page, you will see a list of existing App keys. To generate a new App key, click the “Generate New App Key” button, usually located at the bottom right corner of the “App Key List” section.
This typically includes fields such as:
-
“App Name” - enter a name for the application that will use this App Key. This name is for your reference and does not affect the operation of the App key.
-
“Key Type” - select whether this key will be used for live transaction or sandbox testing.
-
“Redirect URL” - enter the URL where users will be redirected after they have completed an interaction with your application.
Enter the appropriate details for your new key and click “Generate New App Key” to create it.
Once generated, you should see a message confirming the creation of the new App key, along with the key details.
Step 4: Edit an Existing App Key
If you need to change the details of an existing App key, locate the key in the list and click the “Edit Details” button or a similarly labeled option.
Update the App Name or Redirect URL as needed, then click the “Save Changes” or a similarly labeled button to save your changes.
Once you've made the necessary changes, click the “Update App 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 App key”, if everything has been entered correctly, you should see an alert stating “Your App Key has been updated successfully”
Step 5: Delete an App Key
If you want to delete an App Key, find the “Delete Key” option next to the App key you wish to remove. Click on it to initiate the deletion process.
A prompt will appear with the warning: “Confirm Delete App Key. Are you sure you want to delete your App Key?”
If you're sure you want to delete the App Key, click the “Delete App Key” button, usually a green button in the dialog. If you've changed your mind and do not want to delete the App Key, click the “X” button in the top right corner to close the dialog.
After clicking “Delete App Key”, if everything is correct, you will see an “App Key Revoked” alert.
Step 6: Verify the Changes
After generating, editing, or deleting App keys, you should see the corresponding changes on the App Key Management page. Verify that the App keys are correctly displayed and that any new, edited, or deleted App keys are reflected in the list.
Regularly manage your App keys to ensure that only necessary and secure connections to your application are maintained. Review this list periodically to revoke keys that are no longer in use or to generate new ones as required.
Step 7: Handling Errors
If there are any issues with your actions, the platform will display an appropriate error message. For example, if you try to generate more than the maximum allowed number of App keys, you will see an error message like “You have allocated the maximum number of Apps.”
Ensure that you read these error messages carefully and make the necessary adjustments to your actions.
Remember, App keys are sensitive data. They should be stored securely and never shared with unauthorized individuals. If you believe an App key has been compromised, it should be revoked immediately and replaced with a new one.
Conclusion
Managing your App keys is a crucial part of maintaining the security and functionality of your application. Follow the steps in this guide to generate, edit, and delete App keys as needed. If you encounter any issues or have further questions, please contact our support team for assistance.
We hope this guide assists you in efficiently managing your App keys, contributing to the smooth operation and integration of your application with other services.
Contact Information for Support and Feedback
Please feel free to contact us if you have any questions about the information covered in this guide or if you need further assistance with managing your App keys. We also welcome feedback on our guides and will be pleased to hear how we can make them better.