API Key Management
SenRa's integration APIs are secured through the use of API keys. Administrative users can generate new keys to provide targeted access to specific features, as well as delete existing keys using the 'API Keys' view, found under 'Administration'.
There are 2 main types of API keys: Application and Customer. Click the 
button to create a new key.
Application API Keys
Application API Keys are used for a wide variety of activities, including:
- Onboarding * (e.g. Device Registration, Activation, De-Activation)
- Application Downlinks
- Device information Updates
- Device Firmware Updates
- Exporting Device Information
Note
Onboarding devices is a critical workflow primarily completed by Application Providers. Details can be found in the App-Provider documentation here.
Application Access Roles
To better secure Network access and configuration, Roles scope access to specific Device APIs. These include:
| Role | URIs |
|---|---|
| Device: Full Access | Device: Downlinks Device: FUOTA Device: Onboarding Device: Read Access |
| Device: Downlinks | /integration/device/sendmsg /integration/device/sendmcastmsg /integration/device/clearmsgs |
| Device: FUOTA | /integration/mcastTransfer |
| Device: Onboarding | /integration/device/status /integration/device/register /integration/device/activate /integration/device/activateOne /integration/device/deactivate /integration/device/update |
| Device: Read Access | /integration/device/csvExport |
Customer API Keys
Customer API Keys provide access to customer billing data, contract data and Base Station management APIs.
Customer Access Roles
The following Customer Roles scope access to the billing and Base Station integration APIs. These include:
| Role | URIs |
|---|---|
| Customer: Full Access | Customer: Billing Access RAN: Read Access RAN: Write Access |
| Customer: Billing Access | /integration/usage/details /integration/usage/contracts /integration/usage/summary |
| RAN: Read Access | /integration/bstn/details |
| RAN: Write Access | /integration/bstn/deploy /integration/bstn/provision /integration/bstn/status |
Deleting an API Key
API Keys cannot be edited: only created or deleted. To delete, select the targeted key's row from the table and press the 
button. A dialog will appear.
When deleting an Application API Key, enter the key's corresponding Application EUI to confirm deletion.
When deleting a Customer API Key, enter the key's corresponding Customer ID to confirm deletion.
