Using the BlackBerry AtHoc SDK APIs
BlackBerry AtHoc
SDK APIsBlackBerry AtHoc
provides the industry-leading enterprise-class notifications management and delivery software. Incorporating multiple notification sources and a variety of delivery channels, BlackBerry AtHoc
products empower organizations to notify targeted audiences of critical, time-sensitive information and workflow events. As a result, enterprises enable target audiences to act on information and events at the moment of high importance, driving business productivity and revenues.BlackBerry AtHoc
provides a suite of portable HTTP and XML-based APIs to facilitate integration of the BlackBerry AtHoc
system with external systems, and provides content synchronization, group and distribution list synchronization, and publishing of alerts.This document describes the suite of API calls, and provides both a technical discussion of how the APIs work and how to use them. It is assumed that the reader is familiar with the
BlackBerry AtHoc
product, the end-user interaction, and the use of the Management System.The
AtHoc
SDK APIs are based on XML over HTTP. The two main methods to use the API are:- By HTTP POSTing the XML document toAtHocSDK listener. This method allows sending several API requests (payloads) in one XML document by wrapping the different requests in an SDK envelope. The SDK envelope contains authentication and identification parameters for the SDK request(s).
- In some cases,BlackBerry AtHoccan be configured to pull the data from a configured URL. The pulling context determines the expected data format, and only the payload needs to be transferred from the data source.
The following sections describe how to connect to the
AtHoc
SDK and the SDK envelope used for posting SDK requests.