What is the BlackBerry AtHoc API?

Note: This document does not contain a full list of the available API endpoints. This list, including detailed definitions of each endpoint, is available in the interactive documentation installed with BlackBerry AtHoc and can be accessed at [server-address]/api/v2/docs.

BlackBerry® AtHoc® integrates with existing systems to create a comprehensive end-to-end crisis communication system. A common integration use case is to synchronize all user contact details between an authoritative source and BlackBerry AtHoc. This integration is possible thanks to an extensible set of web APIs. The APIs are designed to integrate a BlackBerry AtHoc system with other systems to make alerting more successful.

BlackBerry has incremented the web-based API to include new REST endpoints. The new REST-based web APIs are referred to as the BlackBerry AtHoc API V2.

This document describes how to get started using the BlackBerry AtHoc API V2. This document assumes that the reader is familiar with the BlackBerry AtHoc product, the end-user interaction, and the use of the management system. Familiarity with API V1 is helpful but not required.

This document also assumes that the reader has a customer relationship with BlackBerry or is working as a developer for a BlackBerry customer.