Skip to main content

3. Interface and Features (Page-by-Page Guide)

3.9 API Access

The API Access section of the admin panel provides a secure interface for managing API keys — unique credentials that allow external systems and applications to connect to the Tokenizer.Estate platform programmatically. These keys are typically used for integrations (e.g., Zapier, reporting tools, CRM systems) and should be handled with strict security practices.

3.9.1 List of API Keys

Each entry in this list represents one API key generated for your company’s admin panel. This section allows staff to:

  • View all existing keys
  • Check creation and usage dates
  • Identify the purpose of each key
  • Revoke unused or compromised keys

3.9.1.1 Search & Filtering

The API Access page provides multiple ways to locate specific keys:

  • Column sorting: Small arrows to the right of the column name can be used to sort by the column content; pressing the icon again will sort in the opposite direction. There are different types of sorting for different columns:
    • alphabetically (A–Z / Z–A) for text columns such as Name/Purpose
    • by date (from earliest to latest and back) for Created at and Last online
    • by status order for the Status column
  • Column Filters:
    • Key identifier — free text input for searching by the API key identifier.
    • Name / Purpose — free text input for searching by the key label/purpose.
    • Created at — date range picker for filtering by the key creation date.
    • Last used at — date range picker for filtering by the last time the key was used.
    • Expiration date — date range picker for filtering by the key expiration date.
    • Status — dropdown filter with a list of statuses (e.g., Active, Inactive).

3.9.1.2 API Keys Data Table

Each row in the table includes the following columns:

Column Description
Key Identifier A unique hashed string representing the API key. For security, the full key is shown only once at creation.
Name / Purpose A descriptive label indicating the key’s function (e.g., Zapier_Initial, CRM_Integration).
Created at Date and time the key was generated.
Last used at Date and time the key was last used for an API request.
Expiration date Date and time of the key expiration
Status Current state of the key: Active (enabled and usable) or Inactive (disabled, no longer accepted).

3.9.2 Creating a New API Key

To generate a new API key:

  1. Navigate to the API Access section from the left-hand menu.
  2. Click the green Generate Key button in the top-right corner of the page.
  3. A modal window titled Generate API Key will appear.
  4. In the Name / Purpose field, enter a clear and descriptive label for the key.
    • This should indicate the intended use (e.g., Zapier_Main, CRM_Integration, Analytics_Export).
    • The label will help you identify the key later in the list view.
  5. You can fill the Expired At field.
  6. Click the Generate Key button to proceed.
  7. The system will generate a unique API key and display it only once in full.
    • Important: Copy the key immediately and store it securely in an encrypted location.
    • After closing the modal, you will only see the shortened Key Identifier in the list, not the full key value.

The new API key will now appear in the table with its Key Identifier, Name / Purpose, creation date, and empty “Last used” field until it is first used in an API request.

3.9.3 Deleting an API Key

To revoke an API key:

  1. Locate the key in the list.
  2. Click the revoke icon in the Actions column.
  3. Confirm the revocation in the prompt.

Note: Once revoked, the key cannot be recovered. Any external system using the deleted key will immediately lose access to the API.