BlackBerry UEM Web Services

Get Started with BlackBerry Development Tools

Get Started with BlackBerry UEM Web Services

Develop your first app that automates administrative tasks and integrates with BlackBerry UEM with the help of BlackBerry UEM Web Services and BlackBerry Web Services.

Learn

Learn about BlackBerry UEM Web Services and BlackBerry Web Services components, benefits and architecture.

The BlackBerry Web Services are a collection of SOAP web services that you can use to create apps to manage your organization's BlackBerry UEM domain. Starting with UEM 12.6, you can also get access to BlackBerry UEM Web Services which are the collection of REST APIs. You can use both together or separate to develop applications that manage and integrate with the BlackBerry UEM domain, user accounts, applications, devices and more. You can develop applications that automate and combine several tasks that administrators would typically perform using the management console.

The BlackBerry Web Services and BlackBerry UEM Web Services are installed when you install BlackBerry UEM. BlackBerry Web Services consists of two interfaces: BWS, which contains a single WSDL for all available methods, and BWSUtil, which is used to configure authentication credentials that applications use to access the BlackBerry Web Services.

A request may require authentication from an administrator account before it can be completed. The roles and permissions that are associated with the administrator account determine what APIs the application can use, and what management tasks the application can perform. For example, if you create an application to add user accounts to BlackBerry UEM, the administrator account that the application uses must have permission to create users. To run a BlackBerry Web Services app, computers must have authenticated access to the BlackBerry UEM domain.

To use the BlackBerry Web Services and BlackBerry UEM Web Services, you should be proficient in one of the supported programming languages and in the use of XML, SOAP, REST, JSON and WSDL. You should also be familiar with the configuration and administration of BlackBerry UEM, including the management of user accounts, groups, IT policies, software configurations, and security settings. Learn more about BlackBerry UEM through the BlackBerry UEM Administration Guide.

BlackBerry Web Services

A collection of SOAP web services that you can use to perform administrative tasks in your organization's UEM domain.

BlackBerry UEM Web Services

A collection of REST APIs that that perform similar tasks to BlackBerry Web Services but are exposed via RESTful endpoint.

UEM Core

The UEM Core is the central component of the UEM architecture and consists of several subcomponents that are responsible for:

  • Logging, monitoring, reporting, and management functions
  • Authentication and authorization services for the UEM Core local directory and company directories
  • Scheduling and sending commands, policies, and profiles to the devices

If there are multiple UEM instances in the domain, all the UEM Core instances are active and each of them can connect to the BlackBerry Infrastructure and process traffic.

BlackBerry Infrastructure

The BlackBerry Infrastructure registers user information for device activation and validates licensing information for UEM. Communication between the BlackBerry Infrastructure and UEM is authenticated and encrypted to provide a secure communication channel into your organization for devices outside the firewall.

BlackBerry Router

The BlackBerry Router is an optional component that acts as a proxy server for connections over the BlackBerry Infrastructure between UEM and devices.

Client application

A custom app that you can develop and integrate with the BlackBerry Web Services to manage user accounts and devices that are associated with UEM.

Your apps use the administrator account credentials to authenticate with the BlackBerry Web Services. After an application is authenticated, the BlackBerry Web Services are initialized, and the BWS and BWSUtil web services are ready to receive API calls from the application.

Management console

The management console is a web-based UI that you can use to:

  • Complete post-installation configuration settings
  • View and manage users, devices, policies, profiles, and apps
  • View and manage system settings, including customizing the activation email message or adding an APNs certificate
  • Move IT policies, profiles, groups, and users to UEM

The management console also provides access to UEM Self-Service and allows iOS device users to manage apps using the Work Apps icon.

APNs

The APNs is a service that Apple provides that sends notifications to iOS devices. UEM sends notifications to iOS devices to contact UEM for updates and to report information for your organization’s device inventory. These notifications are sent to the BlackBerry Infrastructure, where they are sent to the device using the APNs.

GCM

GCM is a service that Google provides for Android devices. UEM sends notifications to Android devices to contact UEM for updates and to report information for your organization’s device inventory. These notifications are sent to the BlackBerry Infrastructure, where they are sent to the device using the GCM.

Configure

BlackBerry Web Services offers developers their choice of Java and Microsoft .NET frameworks for high productivity development.

Requirements for BlackBerry Web Services

Java:

For detailed instructions on how to configure your environment in order to use BlackBerry Web Services with Java, please review the BlackBerry Web Services Development Guide Java.

.NET:

For detailed instructions on how to configure your environment in order to use BlackBerry Web Services with Microsoft .NET, please review the BlackBerry Web Services Development Guide Microsoft .NET.

Develop

Now that you have your environment all set up, you are ready to develop your apps. BlackBerry provides API references, samples and walkthroughs to guide you successfully through the development process.

 

BlackBerry Web Services API Reference

The API reference describes the interfaces, classes, methods, and data types of the BlackBerry Web Services. View the BlackBerry Web Services for API Reference.

Code Samples

To see some examples of how to use the APIs, visit BlackBerry Web Services samples on GitHub and download sample apps for JavaC#, and PowerShell.

Success! Continue

After creating your first app, continue to explore the extensive collection of APIs, samples and the entire development guides. You can fast path to these resources by visiting the “Resources” section of BlackBerry Developers.

Also visit the Developer Community to get help from other BlackBerry Developers.