What are the BlackBerry Web
Services?
BlackBerry Web
Services
?BlackBerry UEM
offers a collection of REST APIs and SOAP APIs that you can use to create apps to customize how your organization monitors and manages a BlackBerry UEM
domain. You can use the APIs to automate many tasks that administrators typically perform using the UEM
management console. For example, you can create an app that automates the process of creating user accounts, adds users to multiple groups, and manages users' devices. Both API collections are installed with BlackBerry UEM
.The
BlackBerry Web
Services
SOAP APIs are still supported and released with every version of BlackBerry UEM
, but are officially in maintenance mode. See the BlackBerry Web Services 12.9 SOAP API reference for complete information about the supported legacy SOAP APIs. For information about the BlackBerry
Dynamics
SOAP APIs that are compatible with the BlackBerry Web
Services
SOAP APIs, see BlackBerry UEM compatibility with the BlackBerry Dynamics SOAP APIs.If your organization uses the
BlackBerry Web
Services
SOAP APIs, going forward BlackBerry
recommends transitioning to the BlackBerry Web Services REST APIs. The REST APIs are updated with new functionality in every BlackBerry UEM
release.APIs | Description |
|---|---|
BlackBerry Web
Services SOAP APIs | A collection of SOAP web services supported by BlackBerry UEM version 12.4 and later. The SOAP APIs provide your custom apps with access to a variety of UEM management features, including the ability to add and activate user accounts, assign profiles and IT policies, send commands to devices, and so on.The SOAP APIs also provide compatibility with key BlackBerry
Dynamics SOAP APIs (GC SOAP and CAP SOAP) for UEM environments that have been integrated with a standalone Good Control server (for more information, see the Compatibility with BlackBerry
Dynamics SOAP APIs Reference Guide). |
BlackBerry UEM REST APIs | A collection of REST APIs supported by BlackBerry UEM version 12.6 and later. The REST APIs offer custom apps access to a growing list of UEM management features using a RESTful endpoint structure that is accessed using HTTP.You can use REST APIs to manage user accounts, apps, activation passwords, email templates, profiles, and more. The list of available REST APIs will continue to grow with each UEM release. For more information about the REST APIs, see "Getting Started with REST" on the Inside BlackBerry Developer Blog.The REST APIs offer improved performance compared to SOAP and provide full support for JSON objects (requests and returns are formatted in JSON). Many of the EMM functions offered by Good Control are now available as REST calls. |
The rest of this guide takes you through the set up and use of the
BlackBerry Web
Services
SOAP APIs. The information you need to get started with the REST APIs can be found in the BlackBerry UEM REST API Reference. You can also see the "Getting Started Guide for making web services calls" on the Inside BlackBerry Developer Blog.To use the REST APIs or SOAP APIs, you should be proficient in one of the supported programming languages and related concepts. For the SOAP APIs, you should be familiar with the use of SOAP, XML, and WSDL, and for the REST APIs you should be familiar with REST calls and JSON. You should also be familiar with the configuration and administration of
UEM
, including the management of user accounts, groups, IT policies, profiles, and security settings.