Custom API Creation (Nexus)

The Nexus Dashboard provides users with a simple and secure interface to create, configure, and manage their own API keys. These keys allow seamless integration with Alterscope’s ecosystem, enabling users to interact with data and services programmatically.

Features of Nexus

  • API Key Creation: Generate secure API keys with customizable permissions and expiration periods.

  • Permission Controls: Tailor access to specific actions such as reading, writing, or updating data.

  • Activity Monitoring: Track recent API usage and transactions directly from the dashboard.

  • User-Friendly Management: Easily view, edit, or revoke API keys as needed.


How to Create an API Key

  1. Access the Developer Dashboard

    • Navigate to the Nexus section in the Alterscope app.

    • View all existing API keys and recent transactions.

  2. Create a New Key

    • Click the + Add Key button in the API Keys section.

    • Fill out the required fields:

      • Name: Assign a unique name to your API key for easy identification.

      • Expiration Period: Choose from available options (e.g., 1 day, 1 week, 1 month, 3 months) based on your needs.

  3. Set Permissions

    • Select the permissions your API key will have. Examples include:

      • readrtm: Access real-time monitoring data.

      • creatertm: Create real-time monitoring configurations.

      • updatedata: Modify existing datasets.

      • deletertm: Remove real-time monitoring setups.

    • Combine multiple permissions to grant comprehensive or restricted access.

  4. Generate the Key

    • Click Create to generate the API key.

    • Copy the generated key immediately, as it will not be shown again for security reasons.

    • Click Dashboard to return to the main view or Manage Keys to review existing keys.


Managing API Keys

  1. Viewing Keys

    • All active keys are displayed in the API Keys section, including their:

      • Name

      • Credits Used

      • Last Used timestamp.

  2. Editing Keys

    • Select an existing key to modify permissions or extend its expiration period.

  3. Revoking Keys

    • Delete an API key if it is no longer needed or compromised by clicking the Revoke option.

Monitoring API Usage

The Recent Transactions section provides insights into API activity:

  • Track requests made using specific keys.

  • Identify patterns or anomalies in API usage.

  • Monitor credit usage to ensure API calls remain within limits.

Best Practices for API Key Management

  • Restrict Permissions: Only grant the permissions necessary for your use case to minimize security risks.

  • Set Expirations: Use shorter expiration periods for temporary projects or testing environments.

  • Monitor Activity: Regularly review usage logs to ensure authorized access.

  • Revoke Unused Keys: Remove keys that are no longer required to maintain security.

Last updated