API Keys

API Keys allow you to grant programmatic access to the Netmore Connect REST API. These keys are scoped by customer and rights, making them ideal for secure automation, system integrations, or external service access.

From the Customer Detail Page, you can access API Key management using the API Keys tab in the left-hand navigation. This section displays a list of existing keys and allows you to create, edit, or delete them.

Creating an API Key

To create a new API key:

1. Enter a Name

   • This is a label for internal identification (e.g., myAPI, BillingScriptKey, etc.).

2. Add Rights

   • Click the + icon under the Rights section to define access permissions.

3. Select Customer and Role

   • Choose the customer or sub-customer that the key should apply to.

   • Assign a role (e.g., Device Basic Data (RO), Customer Admin, Device Payload).

   • You can define fine-grained access using individual checkboxes for data upload, downlink, attachments, and more.

4. Multiple Rights Allowed

   • A single API key can have rights assigned across multiple customers or sub-customers, each with different role levels.

5. Save the API Key

   • Once all rights are defined, click Save to generate the key. It will appear in the API key list and can be used immediately to generate access tokens.

Example Use Case

A single API Key (myAPI) can:

• Read basic device data from Netmore-Customer

• Act with full administrative rights on Netmore-SubCustomer

This flexibility supports multi-tenant automation and central system integrations.