APIs

Generating an API Key: Step-by-Step Guide

Creating an API key is a straightforward process. Follow these steps to generate and manage your API key with ease:

• Log in and Navigate

  After logging into the admin application, go to the API page.

• Generate API Key

  Click on the "Generate API Key" button.

  

• Provide a Name

  Enter a descriptive name for your API key to easily identify its purpose.

  

• Save the Key

  Click the "Save" button to create the API key.

  

• Copy the API Key

  Once generated, tap the "Copy" button to copy the key for use in your application.

  

  Your API Key has been generated successfully. Please copy it now, as it will only be displayed once.

⚠ Important: Keep your API key secure and do not share it publicly.

---

Deleting an API Key: Step-by-Step Guide

Once an API key is created, users can manage it easily through the API Key Overview section. Here’s how:

• API Key Overview

  After generating an API key, it will be automatically added to the list under the API Key Overview section.

  

• View API Key Details

  Users can see the API key, its status, and other relevant details, helping them track and manage access.

• Deleting an API Key

  If an API key is no longer needed, users can delete it by tapping on the "Delete" button.

  

• Confirmation Prompt

  A confirmation message will appear, asking the user to confirm the deletion to prevent accidental removal.

  

• Removal from the List

  Once confirmed, the API key will be permanently removed from the list of API keys.

⚠ Important: Deleting an API key is irreversible. Ensure you no longer need the key before proceeding with deletion.

---