Push Channel Notifications API

Owned by Mei Soong (Unlicensed)
Last updated: Jul 14, 2020 by Wendy Liang (Unlicensed)
3 min read

This technical document describes the AppArmor Push Notifications API and how it can be used by external systems to send mass notifications through AppArmor custom mobile safety apps.

If you want to use API, let us know, as we will need to get an API key set up.

Please note that the API must be used by a qualified developer. AppArmor does not provide software development training, nor does our team know the details of implementing the API in all programming environments. Our support team is able to provide general support and troubleshooting help for the API, but they will be unable to assist with the unique implementation details of your systems. For these reasons, the API should only be used when no other alternative is available, as it is generally best to use the core AppArmor functionality whenever possible.

API Endpoint

The AppArmor Push Notifications API is a simply SOAP web service.  The web service requires a 40-digit alphanumeric API key issued by AppArmor to make any requests to the service. Each API key is associated with a specific app and will allow sending notifications only to the associated app.

The API endpoints are:

The API endpoints also support SSL at these addresses:

To obtain an API Key, please contact AppArmor Mobile.

Overview

There are two commands available, they are “Send” and “SendChannel”.  The “Send” command broadcasts a notification to all app users.  The “SendChannel” command allows you to specify a group of users (known as a channel). 

There are two common channels available, they are “alert” and “draft”.  The “alert” channel is all subscribed users (sending a notification to the “alert” channel is the same as using the “Send” command.)  The “draft” channel is used for sending test alerts to users.  Users can subscribe to the “draft” channel using an app specific password provided by AppArmor.  Contact our support team to obtain the password and instructions to subscribe to draft notifiations.

Custom channels can be created as well.  Send to custom channels by specifying the channel id using the “SendChannel” command.


Send Command

To send a notification use the “Send” operation with the following parameters:

  • APIKey: Represents the API Key for the AppArmor app to receive the notification.

  • Title: Title of the notification.  35 characters max. If more than 35 characters are included, the Title will be truncated and only include the first 35 characters.

  • Message: Message body, may contain fully qualified URLs.  120 characters max. If more than 120 characters are included, the Message will be truncated and only include the first 120 characters.

If an error occurs, the following exceptions may be thrown.  Please ensure that your software is able to handle these exceptions:

  • Notification Error: Invalid API Key.

  • Notification Error: Unexpected exception.


SendChannel Command

To send a notification use the “SendChannel” operation with the following parameters:

  • APIKey: Represents the API Key for the AppArmor app to receive the notification.

  • Title: Title of the notification.  35 characters max. If more than 35 characters are included, the Title will be truncated and only include the first 35 characters.

  • Message: Message body, may contain fully qualified URLs.  120 characters max. If more than 120 characters are included, the Message will be truncated and only include the first 120 characters.

  • Channel: The channel (group of users) that should receive the notification. 

If an error occurs, the following exceptions may be thrown.  Please ensure that your software is able to handle these exceptions:

  • Notification Error: Invalid API Key.

  • Notification Error: Unexpected exception.


API Support

Support is available for API developers.  Send support requests to support@apparmor.com for assistance.