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:

  • Global Search Bar: Search across all keys using any part of the key identifier or its name/purpose.
  • Column Sorting: Small arrows on the right of column names allow sorting; clicking again reverses the order.
    • Alphabetical ascending/descending: For text columns like Name / Purpose.
    • Date from earliest to latest (and vice versa): For Created at and Last used at.
  • Column Filters:
    • Text Filter — available for Key Identifier and Name / Purpose.
    • Date Selector — available for Created at and Last used at to filter within a date range.
  • Reset All Filters: Clears all applied filters and restores the full list view.

3.9.1.2 API Keys Data Table

Each row in the table includes the following columns:

ColumnDescription
Key IdentifierA unique hashed string representing the API key. For security, the full key is shown only once at creation.
Name / PurposeA descriptive label indicating the key’s function (e.g., Zapier_Initial, CRM_Integration).
Created atDate and time the key was generated.
Last used atDate and time the key was last used for an API request.
StatusCurrent state of the key: Active (enabled and usable) or Inactive (disabled, no longer accepted).
Actions• Delete API key (permanently disables access)

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 New 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. Once the field is filled, the Generate Key button becomes active. Click it to proceed.
  6. 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 deletion in the prompt.

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