Tutorial: Creating a Client Application

This tutorial shows you how to create a client application using the API Manager. The ability to create a new application using the API Manager allows members of a provider organization, such as API developers or testers, to create the environment needed to complete an API.

About this tutorial

In this tutorial you will complete the following lessons:
  1. Create a Client Application
  2. Subscribing to Products and APIs

Before you begin

In this tutorial you will create a new client application. You can then subscribe this new application to a product if one exists in your catalog. If you do not have an existing product, complete Tutorial: Importing an API before beginning this tutorial. When you import the API, a product is created for it automatically.

Create a Client Application

To create a client application using the API Manager, complete the following steps:
  1. Log in to API Manager.
  2. In the Home page, click the Manage Catalogs tile.
    Home page
  3. Click the Sandbox Catalog to open it.

    Sandbox Catalog

    The catalog opens to the Products page.

  4. Click the Applications tab.
    Navigate to the Applications page
  5. On the Applications page, click Add.
    Add an application
  6. On the Create Application page, type (or copy and paste) AppOne in the Title field.
  7. In the Consumer Organization field, select the Sandbox Test Organization.

    The Sandbox Catalog includes one consumer organization, which is selected by default.

    The default consumer organization
  8. Click Create.
  9. When the Credentials panel presents the application's credentials, use the Copy button to copy each value in turn and paste it into a file. Then click the x to dismiss the panel.

    You will need these values later for testing purposes and you don't copy the secret now, you will have to generate a new one later.

    Application credentials
The new "AppOne" application displays in the list on the Applications page. By default, the application is enabled and is ready for use.
List of applications

Proceed to the next section to subscribe the application to a Product and an API, so that you can use the application to test them.

Subscribing to Products and APIs

You can subscribe the new client application to an existing published product, which gives the app permission to execute the APIs contained in the product. Complete the following steps to subscribe the client app to a product.

  1. On the Applications page, click the options icon options icon next to the "AppOne" application, and then click Create subscription.

    Application options menu

  2. On the Create Subscription page, select the Product/Plan combination for the API.

    A Product can contain multiple APIs, and a Plan can contain multiple Products. Be sure to subscribe your app to the correct Product and Plan.

    API list

    This tutorial uses the FindBranch auto product that was created by importing the FindBranch API in a previous tutorial.

  3. Click Create Subscription.
  4. On the Applications page, click Application options > View Subscriptions next to the AppOne application.

    The Subscriptions page now lists the new subscription for the "AppOne" application.

    Subscriptions for AppOne

What you did in this tutorial

In this tutorial, you completed the following activities:
  • Created a client application.
  • Subscribed the client to a product that contains an API.