An API key is required for systems or integrations that need programmatic, read-only access to data in a COMANAGE project.

API keys are intended for developers, integration specialists, BIM Managers, and digitalization leads who need structured access to project data.

Each API key is tied to a single project and grants read-only access only.

How to generate an API key

Only Project Administrators can create and manage API keys.

To generate an API key:

1. Open the project.

2. Go to Project Settings.

3. Select the API Access.

4. Click the API Key button.

5. Enter:

   • Name (required)

   • Description (optional)

   • Expiration date (optional)

6. Click Generate Key.

The generated key is displayed only once.

Copy and store it securely. Hand it over to the authorized user or system that needs access, and make sure it is shared securely.

Multiple active API keys can exist for the same project.

Controlling API key validity

API keys can be controlled in the following ways:

• Expiration date (optional):
  After the selected date, the key automatically expires.

• Manual revocation:
  From the API Access list, select an active key and choose Revoke from the context menu.
  Once revoked, the key cannot be reactivated.

Key statuses can be seen in a table column and include:

• Active

• Expired

• Revoked

Viewing API usage logs

The Last Used column allows Project Administrators to see when an API key was last used. From the context menu of the API key, select Usage Log to view the endpoint, IP address, and other details.

Usage logging ensures traceability and supports compliance requirements.

API documentation for integration developers

Developers who use the API key can access the full technical documentation, including available endpoints and request formats, here:

👉 api.nticomanage.com

This documentation provides details on authentication, endpoints, response formats, and example requests.

Where: HOME / <project name> / Project Settings / API Access