Managing API Keys

API keys in Ratl.ai serve as a secure way to access Ratl's public APIs. These APIs enable you to trigger tests directly from external pipelines (e.g., Jenkins, GitLab, GitHub Actions) or other sources, streamlining the integration of Ratl into your existing workflows. This documentation provides a comprehensive guide on how to manage API keys effectively.

---

Features of API Key Management

1. Centralized API Key Organization :

• View all your API keys in a single dashboard.

• Each key includes details such as:

  • API Key Name

  • Created By

  • Expiration Date

  • Actions (e.g., Delete)

1. Generate New API Keys :

• Easily create new API keys with a custom name and expiration period.

1. Copy and Secure API Keys :

• Securely store API keys, as they won’t be displayed again after generation.

1. Seamless Integration :

• Use API keys to interact with Ratl public APIs for triggering tests or accessing test results.

---

Accessing the API Keys Section

1. Navigate to the Settings Page:

• Log in to Ratl.ai.

• Click on the Settings tab in the navigation bar.

2. Open the API Keys Section:

• Inside the Settings page, locate the API Keys section.

• Click on it to view all your existing API keys or to generate new ones.

---

How to Manage API Keys 1. View Existing API Keys

• Navigate to the API Keys Management section.

• The dashboard displays all your API keys in a tabular format:

  • API Key Name : The user-defined name for the key.

  • Created By : The email ID of the user who created the key.

  • Expiration Date : When the API key will expire.

  • Actions : Options to delete a specific API key.

Example: The image above shows keys named "TEST" and "test2," created by users with their respective expiration dates.

---

1. Search for an API Key

• Use the search bar at the top of the table to quickly locate a specific API key by name.

---

1. Create a New API Key

• Click the + Create New button.

• Fill in the following details in the modal:

  1. API Key Name :

  2. Enter a descriptive name (e.g., "Pipeline Trigger Key").

  3. Expiration Period :

  4. Choose a predefined duration (e.g., 30 days, 60 days) or set a custom expiration date.

• Click Generate to create the API key.

---

1. Secure the Generated API Key

• After generating an API key, the key will be displayed only once.

• Copy the key to a secure location (e.g., password manager) to prevent losing access.

• The modal includes:

  • API Key Name

  • Generated API Key

  • A Copy Button to quickly copy the key.

Note : Once you close the modal, the key cannot be retrieved.

---

1. Delete an API Key

• Locate the key you want to delete in the table.

• Click the trash icon under the "Actions" column.

• Confirm the deletion to remove the key permanently.

---

Using API Keys

For detailed instructions on using API keys, refer to the Integrating ratl with your ci/cd pipelines.

---

Best Practices for API Key Management

• Secure Your Keys : Store API keys in a password manager or secure environment variable.

• Set Expiration Dates : Regularly expire and regenerate keys to enhance security.

• Use Descriptive Names : Use meaningful names for keys to avoid confusion (e.g., "Jenkins Functional Test Key").

• Delete Unused Keys : Remove keys no longer in use to prevent unauthorized access.

---

Common Use Cases

1. Integrating with CI/CD Pipelines :

• Automate testing workflows by triggering Ratl tests directly from build pipelines. Check the guide here.

1. On-Demand Test Execution :

• Trigger tests programmatically from any external system using the API key.

1. Accessing Test Results :

• Fetch real-time test reports or logs for integration into dashboards or monitoring tools.

---

Postconditions After managing your API keys, you should:

1. Have secure access to Ratl public APIs for test automation.

2. Easily integrate Ratl testing capabilities into your pipelines and external systems.

3. Maintain organized and secure API keys to prevent unauthorized usage.

---