Blockchain as a Service (BaaS)
This document details the operation of the BaaS component, which is responsible for managing the API Keys used within the application. The system allows for two levels of management: the User/Developer level (management of own keys) and the Administrator level (management of administrative keys and those of other companies).
1. User API Key Management
This section describes how a standard user interacts with the interface to manage their access credentials.
1.1. Initial View
When accessing the module, the user sees the "User API Keys" table. Initially, if no records exist, the table will be empty, offering the main option to create a new credential.
1.2. Creating a New API Key
To generate a new credential, the user must press the “NEW API KEY” button. Upon doing so, a modal form is displayed.
The user must complete the following steps:
-
Fill in the data: Assign an identifying name to the key (e.g., "API-Enterprise-1").
-
Choose validity time: Select the duration of the key from the dropdown menu. Available options include:
- Day
- Week
- Month
- Year
- Unlimited
Once the form data is completed and the action is confirmed, the system creates the API Key with the estimated validity.
1.3. List and Key Details
After creation, the new record will immediately appear in the BaaS table. The user can see summarized information (Name, fragment of the API Key, creation and expiration dates).
Upon opening the details of a specific record, the system provides vital technical information for integration:
- Network URL: Endpoint for making requests.
- API KEY: The full key string.
- Code snippets: Usage examples in languages such as CLI (curl), TypeScript (ethers), and Python (web3.py).
1.4. Key Deletion
The system allows the user to revoke access by deleting an existing key.
After confirming the deletion, the record disappears from the list, updating the table to its previous state or showing the remaining records.
