Manage Devices with the AerAdmin API

The AerAdmin API enables you to programmatically manage your account, devices, and alerts. AerAdmin provides different endpoints (URLs where the API receives requests for resources or functionality) that correspond with various actions. For example, one endpoint can help you retrieve details about a specific device, while another can help you provision your devices.

Note: You can also perform these tasks in the AerPort portal.

To use the AerAdmin API, you must have your Account API Key:

For more information, see Manage API Keys.

To use the devices/details endpoint to get detailed information about a specific device:

1. Open a new tab in Postman and set the request type to POST.
2. Enter the following URL and replace {apiKey} with your account API key:

   https://aeradminapi.aeris.com/AerAdmin_WS_5_0/rest/v1/devices/details?apiKey={apiKey}

3. Select the Headers tab and enter the following key/value header pairs:

   Key	Value
   Accept	application/json
   Content-Type	application/json
   Accept-Charset	utf-8

4. Select the Body tab, set the type to raw, and ensure JSON is selected.
5. Enter the following JSON body and replace each item in {} with the appropriate information for your account.

   Note: Since the endpoint enables you to search for a device based on different IDs (e.g., MEID, IMSI, etc.), you must enter the appropriate device fields based on the type of search. For example, the following body includes IMSI to search for a device based on its IMSI value:

   {
   "accountID": "{accountID}",
   "email": "{email}",
   "IMSI": "{deviceIMSIValue}"
   }

   

   For more information, see the Get Device Details section in the API Reference Guide.

6. Click Send to invoke the request. A successful response Status is 200 OK and the response body should look similar to the following:

   

To use the /accounts/<accountId>/device/<deviceIdType>/<deviceId>/ activity endpoint to retrieve device activity:

1. Identify the device’s IMSI or ICCID.
2. Open a new tab in Postman and set the request type to GET.
3. Enter the following URL and replace the following information with your account or device details:
   • {accountId}: Your account ID.
   • {deviceIdType}: Either IMSI or ICCID, depending on the identifier you want to use.
   • {deviceId}: Your device’s IMSI or ICCID value, depending on the {deviceIdType} you want to use.
   • {apiKey}: Your API key.

   https://aeradminapi.aeris.com/AerAdmin_WS_5_0/rest/accounts/{accountId}/device/{deviceIdType}/{deviceId}/activity?apiKey={apiKey}

4. Select the Headers tab and enter the following key/value header pairs:

   Key	Value
   Accept	application/json
   Content-Type	application/json
   Accept-Charset	utf-8

5. Click Send to invoke the request. A successful response Status is 200 OK and the response body should contain a collection of objects describing activities, similar to the following:

   [
   	{
       	"deviceId": 39193529,
       	"accountId": 11173,
       	"changeDate": "2023-11-18",
       	"changeType": "Status",
       	"changeValue": "Bill",
       	"changedBy": "aerport@aeris.net",
       	"mdn": "11835420739",
       	"meid": null,
       	"hexMeid": null,
       	"iccid": "89185000150911597645",
       	"imei": "353439061100592",
       	"imsi": "204043396464386",
       	"msisdn": "11835420739",
       	"min": null,
       	"esn": null,
       	"hexEsn": null,
       	"eid": null,
       	"technology": "LTE",
       	"deviceProfileId": "AER0000006169012",
       	"primaryTechnologyOfNewDevice": null
   	},
   	{
       	"deviceId": 39193529,
       	"accountId": 11173,
       	"changeDate": "2023-11-18",
       	"changeType": "Status",
       	"changeValue": "Suspend",
       	"changedBy": "aerport@aeris.net",
       	"mdn": "11835420739",
       	"meid": null,
       	"hexMeid": null,
       	"iccid": "89185000150911597645",
       	"imei": "204043396464386",
       	"msisdn": "11835420739",
       	"min": null,
       	"esn": null,
       	"hexEsn": null,
       	"eid": null,
       	"technology": "LTE",
       	"deviceProfileId": "AER0000006169012",
       	"primaryTechnologyOfNewDevice": null
   	},
   ...
   ]

To use the /rest/<accountID/bulkoperations/<transactionId> endpoint to get general information about a transaction, including the status of a bulk operation:

1. Identify the ID of the transaction that you want to get information about.
2. Open a new tab in Postman and set the request type to GET.
3. Enter the following URL and replace {accountId} and {apiKey} with your account ID API key respectively. Replace {transactionId} with the ID of the transaction.

   https://aeradminapi.aeris.com/AerAdmin_WS_5_0/rest/{accountID}/bulkoperations/{transactionId}?apiKey={apiKey}

4. Select the Headers tab and enter the following key/value header pairs:

   Key	Value
   Accept	application/json
   Content-Type	application/json
   Accept-Charset	utf-8

5. Click Send to invoke the request. A successful response Status is 200 OK and the response body should contain transaction information, similar to the following:

   {
   	"email": "AerisTechPubs@gmail.com",
   	"transactionID": "66db8e17-4cdf-44a5-9554-15462f7e322",
   	"operation": "BulkProvision",
   	"operationStatus": "Complete",
   	"operationCount": 2,
   	"successCount": 2,
   	"failCount": 0,
   	"inProgressCount": 0,
   	"createDate": "11/20/2023 14:45:38",
   	"modifiedDate": "11/20/2023 15:53:16",
   	"accountID": 27585,
   	"userID": 0,
   	"processedOperationCount": 2,
   	"emailSent": "Success"
   }

To use the /rest/accounts/<accountId>/alerts/profiles endpoint to get the connectivity alert settings for a specific account:

1. Open a new tab in Postman and set the request type to GET.
2. Enter the following URL and replace {accountId} and {apiKey} with your account ID API key respectively:

   https://aeradminapi.aeris.com/AerAdmin_WS_5_0/rest/accounts/{accountId}/alerts/profiles?apiKey={apiKey}

3. Select the Headers tab and enter the following key/value header pairs:

   Key	Value
   Accept	application/json
   Content-Type	application/json
   Accept-Charset	utf-8

4. Click Send to invoke the request. A successful response Status is 200 OK and the response body should contain a collection of objects describing alerts, similar to the following:

   [
   	{
       	"alertThresholdId": 128050,
       	"accountId": 11173,
       	"name": "Monthly 1 MB Alert",
       	"description": "Alert if data traffic goes over 1 MB during the month",
       	"alertType": "Packet",
       	"groupType": "Account",
       	"groupId": "27",
       	"deviceType": "",
       	"aggregateToGroup": true,
       	"timeInterval": "BillingCycle",
       	"timeIntervalUnit": null,
       	"timeIntervalValue": null,
       	"minValue": 0,
       	"maxValue": 1,
       	"unitOfMeasurement": "MB",
       	"textValue": null,
       	"effDate": "12-17-2022 00:00:00",
       	"expDate": null,
       	"createdBy": "aerport@aeris.net",
       	"createdDate": "12-17-2022 00:35:52",
       	"lastUpdatedBy": "aerport@aeris.net",
       	"lastUpdatedDate": "12-17-2022 00:35:52",
       	"alertCategory": null,
       	"alertSubType": "Packet",
       	"minThresholdUnit": "MB",
       	"masterAlert": false,
       	"thresholdType": "Usage",
       	"previsionVersionId": 0,
       	"actions": [
           	{
               	"actionId": 1,
               	"type": "Email",
               	"description": "send an email when a threshold is crossed",
               	"actionValue": null,
               	"effDate": null,
               	"expDate": null,
               	"createdBy": "aerport@aeris.net",
               	"createdDate": "2022-12-17",
               	"lastUpdatedBy": "coachleslie2012+10@gmail.com",
               	"lastUpdatedDate": "2022-12-17"
           	}
       	],
       	"deviceProfileLevel": false,
       	"prepaid": false
   	},
   ...
   ]