Blackberry Administration API 5.0 US

Embed Size (px)

Text of Blackberry Administration API 5.0 US

BlackBerry Administration APIVersion: 5.0

Fundamentals Guide

Published: 2009-03-31 SWD-663601-0331024048-001

Contents1 Designing applications that use the BlackBerry Administration API.................................................................................. Applications that automate administration tasks....................................................................................................................... Applications that allow users to perform administration tasks................................................................................................. Applications that integrate the BlackBerry Enterprise Server with enterprise systems......................................................... Creating UIs to perform specialized tasks................................................................................................................................... 3 3 3 4 4 5 5 6 6 7 7 8 8 8 9 9 9 10 10 11 12 12 12 12 13 16 16 16 16 16 17

2 Web services overview................................................................................................................................................................ WSDL................................................................................................................................................................................................ SOAP................................................................................................................................................................................................ Using the BlackBerry Administration API web services............................................................................................................. 3 Understanding the BlackBerry Administration API............................................................................................................... Architecture: BlackBerry Administration API.............................................................................................................................. Security considerations.................................................................................................................................................................. Authentication and authorization................................................................................................................................................. Types of APIs in the BlackBerry Administration API................................................................................................................... Best practice: Using multi-object APIs to optimize performance.................................................................................... Localizing applications................................................................................................................................................................... Logging............................................................................................................................................................................................. Using code samples and the API reference................................................................................................................................. Using host services and core services to manage the BlackBerry Enterprise Server components....................................... Using the BlackBerry Dispatcher to manage user accounts..................................................................................................... 4 Setting up a development environment................................................................................................................................... Setting up a BlackBerry Enterprise Server environment for testing......................................................................................... Choosing a development platform................................................................................................................................................ Installing the SSL certificate on your development computer.................................................................................................. Generating a client proxy for the web services........................................................................................................................... 5 Development basics.................................................................................................................................................................... Sending requests............................................................................................................................................................................. Specifying authentication credentials................................................................................................................................. Validating the SSL certificate in your application.............................................................................................................. Creating a data object instance............................................................................................................................................ Processing responses.....................................................................................................................................................................

Handling errors and exceptions.................................................................................................................................................... 6 Glossary......................................................................................................................................................................................... 7 Provide feedback......................................................................................................................................................................... 8 Legal notice..................................................................................................................................................................................

18 19 20 21

Fundamentals Guide

Designing applications that use the BlackBerry Administration API

Designing applications that use the BlackBerry Administration API

1

The BlackBerry Administration API is a collection of document-style web services that you can use to create applications to complete tasks that are normally performed by an administrator using the BlackBerry Administration Service. To use the BlackBerry Administration API, you should be proficient in one of the supported programming languages and should understand common web services concepts and the use of XML, SOAP, and WSDL. You should have a strong understanding of the BlackBerry Enterprise Server components and the tasks associated with managing your organization's BlackBerry Enterprise Server, such as managing user accounts, software configurations, IT policies, and component instances. For more information about the BlackBerry Enterprise Server, visit www.blackberry.com/go/serverdocs to see the BlackBerry Enterprise Server Administration Guide and the BlackBerry Enterprise Server Feature and Technical Overview.

Applications that automate administration tasksYou can use the BlackBerry Administration API to create applications that automate administration tasks to help reduce the amount of time that administrators spend performing common, time-consuming, or complicated tasks when managing the BlackBerry Enterprise Solution. Your applications can help administrators in your organization complete tasks faster and in fewer steps. For example, administrators must perform several steps to activate new BlackBerry devices. You can create an application that automatically creates user accounts, assigns the appropriate IT policies and software configurations to the user accounts, and emails activation passwords to the users to activate their BlackBerry devices over the wireless network.

Applications that allow users to perform administration tasksYou can use the BlackBerry Administration API to create applications to help reduce the amount of time that your organization's administrators spend managing BlackBerry devices by allowing users to perform some administration tasks. For example, you can create a web application that is available on your organization's intranet to allow users to perform the following tasks: Task Activate a BlackBerry device over the wireless network Reset a BlackBerry device password Description If a user requests an activation password, your application can generate and email the activation passwords to the users. If a users' BlackBerry device password is compromised or forgotten, the user can reset their password using your application.

3

Fundamentals Guide

Applications that integrate the BlackBerry Enterprise Server with enterprise systems

Task Install applications on a BlackBerry device

Description If a user requires administrators to install an application on their BlackBerry device over the wireless network, the user can request the device application using your application.

Applications that integrate the BlackBerry Enterprise Server with enterprise systemsYou can create new applications or extend existing applications to manage the BlackBerry Enterprise Server and other enterprise systems within your organization's environment. For example, when a user joins or leaves your organization, your application can provide administrators with a single interface to add or remove the user account from your organization's BlackBerry Enterprise Server, directory server, messaging server, and any other enterprise system for which the user requires an account.

Creating UIs t