Provision applications that can call the web API Skip Navigation

Provision applications that can call the web API

You can provision a new API integration with the
BlackBerry Alert
management system. You must have organization administrator, enterprise administrator, or system administrator permissions to provision applications. You must have system administrator permissions to enable a provisioned application.
The Client ID and Client Secret can only be used in the organization in which they are created. If the Client ID and Client Secret are created in the System Setup (3) organization, they can be used in any organization. If the Client ID and Client Secret are created in an Enterprise organization, they can be used in any of that Enterprise's sub organizations. If the Client ID provided does not follow these inheritance rules, a 400 (Bad request) error code is returned.
  1. Log in to the
    BlackBerry Alert
    management system as an organization administrator, enterprise administrator or system administrator.
  2. In the navigation bar, click The Settings icon.
  3. In the
    System Setup
    section, click
    API Applications
    .
  4. On the
    API Applications
    window, click
    New
    .
  5. On the
    New API Application
    window, enter a name for the API integration.
  6. (System administrators only) Next to
    Status
    , select
    Enabled
    .
  7. In the
    Authentication
    section, select a Grant Type. Password is the default. If you select Implicit, enter a redirect URI in the text box that appears.
  8. Click
    Save
    .  A Success message appears that includes the Client ID and Client Secret.
  9. Take note of the displayed Client Secret. It is displayed only once and will need to be regenerated if lost.
After you provision your application in the
BlackBerry Alert
management system, contact
BlackBerry Alert
customer support to have the application reviewed and enabled.
Reset the client secret
If you need to reset the client secret for your API integration, complete the following steps:
  1. Log in to the
    BlackBerry Alert
    management system.
  2. In the navigation bar, click The Settings icon.
  3. In the
    System Setup
    section, click
    API Applications
    . The API Applications window opens.
  4. Optionally, enter a name in the search box to filter the list of applications.
  5. Optionally, select
    Enabled Applications
    or
    Disabled Applications
    from the
    All Applications list
    to filter the list of applications.
  6. Click the application you want to modify.
  7. Click
    Reset Client Secret
    . A confirmation window opens.
    Any existing calls to the selected API with the existing client secret will be blocked when you reset the client secret.
  8. Click
    Continue
    . You are returned to the API application window. The new client secret is displayed.
  9. Take note of the displayed client secret.
  10. Click
    Save
    .
  11. Add the new client secret to your authentication payload.