API Interface: HTTPS


Authentication is required to access the Aerialink API. The authentication requirements consist of two layers; Firewall and Credentials which are described below.


Prior to accessing the Aerialink API, all accounts must white list their network server specific IP addresses (/32) or network subnet (/subnet). This can be done within the Aerialnk Platform portal under the Authentication section within the API area.


All API requests to Aerialink resources must authenticate using HTTP Basic Access Authentication (encrypted over HTTPS). Your API credentials must be passed with every request that is made to the API. There is not a concept of sessions within any API request/response. Your API credentials (APIKey and APISecret) should 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.

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

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

The use of SSL (Secure Socket Layer) via HTTPS is highly recommended to insure a secure and private connection between your application server and our network. Additionally, to support the highest level of security the support for non-SSL HTTP requests will be phased out at a future date.


If you are having trouble authenticating with the Aerialink API confirm that you have white listed your IP address and that your API credentials are correct. 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.


If you require any additional assistance, please follow these instructions on how to contact the Aerialink support team.

This page was last updated 1515185923000