Getting Started

Before You Begin

Before you access the API, you must have the following:

  1. An active Aerialink Platform account
  2. Access to the Platform Portal
  3. An active Connection properly set up on the applicable account - this will determine the credentials you use to authorize with the API.

More information about using the Platform Portal and setting up connections can be found here.

Accessing the API

Here is the Base URL by which you will access all resources within this API version:

https://apix.aerialink.net/v4

Note: The specific resource that you wish to access must be appended to the end of this base URL. For example, with the messages resource the complete URL would be:

!! Example Only !!: https://apix.aerialink.net/v4/messages

Note2: When binding in, always configure your server with the Aerialink DNS host name (apix.aerialink.net) and not the IP address.

API Interface: HTTPS

Authentication

Authentication is required to access the Aerialink API. The authentication requirements consist of Firewall and Credentials described below.

Firewall

All accounts must whitelist their network server specific IP addresses (/32) or network subnet (/subnet) prior to accessing the Aerialink API. This can be done within the Aerialink Platform portal under the Authentication section within the API area.

Credentials

All API requests to Aerialink resources must authenticate using HTTP Basic Access Authentication (encrypted over HTTPS). Your API credentials must be passed in the HTTP header of the request as basic authentication username and password—not as individual parameters within the body of the request—with every API request, as there is no concept of sessions within any API request/response.

For further information on HTTP Basic Access Authentication,
please see this HTTP Authentication

The Username and Password passed in your API request are your account API Key and API Secret respectively. Note that some accounts may have multiple credential sets depending on requested configuration. Subsequently, each credential set may have different related permissions to API resources or associated resource assets such as Short Codes, Long Codes, or Alphanumeric Codes used for Messaging services.

Encryption and Security

All requests to the Aerialink API over HTTPS are processed using High-Grade Encryption SHA 256 RSA with a 2048 Bit Algorithm. The use of SSL (Secure Socket Layer) via HTTPS is required for requests to be processed with this encryption level. We highly recommend HTTPS connections over HTTP to ensure a secure and private connection between your application server and our network. Aerialink’s support for non-HTTPS requests will be phased out at a future date.

Troubleshooting

If you are having trouble authenticating with the Aerialink API, confirm that you have white-listed your IP address and are using the correct API credentials. You can view the API Authentication Error Log under Reports in the API section of the Platform portal. This will confirm whether your authentication requests are being rejected or not.

This page was last updated 1522878843960