Neo™ connectivity service and APIs

Neo is underpinned by a platform built from the ground up to provide the best possible connectivity service for your M2M solution. As operators of a network processing hundreds of millions of transactions each day, we understand the mandate for control, visibility and scale. Our engineers are relentlessly committed to ensure we’re doing everything we can to help you excel in the quickly emerging IoT market. Nothing is more important to that commitment than giving you the power to automate sophisticated, time-consuming network operations and perform big data analytics in near real-time. We do that by exposing details about your devices’ network activity via a set of APIs. Our APIs are accessible with the appropriate credentials, some publicly and others via VPN connection. This page summarizes what’s available and the rest of this section dives into the details.
API nameDescriptionVPN requiredAPI specs
AerAdmin™Device administration - provision, activate, manageYesRead the specs
AerFrame™Device communication and controlNoRead the specs
AerTraffic™Device reporting for traffic and billing informationNoRead the specs

API process flow overview
api_diagram

API Key

In order to access the Aeris APIs, your application needs to pass an API key to the Aeris server that hosts the interface. The key is a secret token specific to your account which identifies your application. It ensures only your application can use the Aeris API to perform device operations in your account.

Because the API Key is specific to your account and is requested for the operations on your devices, you must ensure that it is kept secret within your organization and that it is not shared with any other organization.

Your API Key can be found on the Account Information page in AerPort. Remember that only the Account Manager(s) of your account have access to this page.

If your level of access to the account is set to User and you need the API Key for your application, please ask your Account Manager.

If you are the Account Manager, finding and using the API Key is simple.

Step 1:

On any tab in AerPort, click the Account icon at the top right corner of the screen, and select Account Information.

Account Information Screen - v01

Step 2:

When the Account Information is displayed, scroll to the bottom of your screen to the API Access section.

API Access Key_v02

Step 3:
Copy the alphanumeric API Key in your application code. In this example, the API Key starts with 94a51 …

AerAdmin – Device Administration

Device administration is accessible to applications through the AerAdmin Web Services API. The AerAdmin API enables the application to automatically manage the life cycle of the device, from initial provisioning through cancellation, including:
  • Provision
  • Activate
  • Suspend
  • Un-Suspend
  • Cancel
In addition to the basic device life cycle management, the API enables rate plan assignment and changes for devices. Applications can make these changes to single devices or as Bulk Actions to multiple devices with one API call. Learn more about using the AerAdmin API to perform device administration.

AerFrame – Device Communication and Control

Communication control to devices is supported through the AerFrame Web Services API set. The AerFrame APIs allow the Web Services application and the device/s to communicate and provides access to SMS services. Features available through the AerFrame API include:

  • MO and MT SMSDirect messages between the device and application
  • Voice call initiation (if supported by the device and subscribed)
Learn more about using the AerFrame API to communicate with your devices.

AerTraffic – Device Reporting

The AerTraffic Web Services interface provides access to various reports related to traffic usage and billing, including:

  • Device Reports
    • Device Detail Report
    • Device Activity Report
    • Device Summary Report
  • Traffic Cost Reports
    • Traffic Cost Daily Report by Device
    • Traffic Cost Summary Report
  • Traffic Reports
    • Traffic Detail Report by Device
Learn more about using the AerTraffic API to generate reports.