Manage Applications using API Hub

Applications are containers of related APIs in
Layer7 API Developer Portal
. Org Users (Org Publishers, Org Admins, and Developers) can access those APIs while building your web/mobile application using the application. Org Publishers and Org Admins can manage the applications using API Hub by adding, or registering, them, by editing them, by controlling which application use specific APIs, by generating new secrets, and by deleting them. Manage applications, for example, when testing your APIs and
API Portal
.
In this article:
Except for viewing applications, the following workflows are available for Portal Admin, API Owner, Org Admin, and Org Publisher. Note that global publishers (Portal Admin and API Owners) can also continue to create and manage applications in API Portal.
View an Application using API Hub
All users can view applications using API Hub. Publishers can view applications for all organizations using API Hub. Org users, including developers, can view applications for their specific organization through API Hub.
Follow these steps:
  1. From the list of applications, select the tile for the application that you want to view.
    The Application Details page appears in view-only mode.
    Only the default key shows in API Hub.
  2. From this page, you can do the following:
    • View the overview of the application. The application overview is additional information about the application.
      For more information about the overview and how to manage this content, see the "Manage the Overview Content for an Application" section.
    • View the details of the application, including the organization and description.
    • View the APIs and API groups/API plans that have been added to the application.
    • View the authentication and credential information for those APIs that have been added to the application that use OAuth.
Manage the Overview Content for an Application using API Hub
For all languages that API Hub supports, the Portal Admin can manage the overview content for applications by adding, editing, and deleting the content.
Follow these steps:
  1. Sign in to API Hub as Portal Admin.
    The Home page appears.
  2. From the Home page, select
    Applications
    .
    The list of applications appears on the Applications page.
  3. Select the tile for the application for which you want to add, edit, or delete an overview.
    The Application Details page appears in view-only mode.
  4. The overview content that you add or edit is in the language that you have selected for API Hub. To add or edit overview content in another language that API Hub supports, switch to that language using the language selector at the top of the page.
  5. In the
    Overview
    section, click
    Edit overview
    (the pencil icon).
    The
    Overview
    page appears.
  6. Add or edit the markdown content for the overview of the application in the pane to the left, the edit pane, and then save your changes.
    The edit pane is a markdown editor. The edit pane and the pane to the right, the preview pane, are a side-by-side view of the overview. You can:
    • Copy and paste markdown into this pane.
    • Format the content that you add using the options on the menu bar or using markdown basic syntax.
    For more information about markdown basic syntax, see the the Markdown Basic Syntax Guide.
The overview content for the application is saved.
Add an Application using API Hub
The applications that you add using API Hub are also available in
Layer7 API Developer Portal
.
Follow these steps:
  1. Sign in to API Hub as Portal Admin, API Owner, Org Admin, or Org Publisher.
    The Home page appears.
  2. From the Home page, select
    Applications
    .
    The list of applications appears on the Applications page.
  3. Select
    Add Application
    .
    The Add Application page appears.
  4. Provide details about the application. Provide a unique application name and optionally a description.
  5. In the
    API Management
    section, add or remove available APIs and API groups/API plans to or from your application.
    In addition to the listed APIs and groups/plans, you can search using the search field.
    If API plans are turned on, then API groups do not display.
    Do the following:
    • To remove a selected API or API group/API plan from the application
      , select (the x icon) for the API or API group/API plan that you want to remove. The list of selected APIs and API groups is under the
      Selected APIs
      and
      API Groups
      section.
    • To add an available API or API group/API plan to your application
      , select (the plus icon) to the left of the API or API group/API plan that you want to add, and then accept the terms and conditions of the end-user license agreement (EULA). The list of available APIs and API groups/API plans is under the
      Available APIs
      (or
      Available API Groups/Available API Plans
      ) section.
      When you add an API group/API plan to your application, you add the APIs that are contained within the group/plan to your application. These APIs are enabled and public. If the APIs that are contained within the group/plan are enabled but private, then the APIs belong to your organization and have been added to the account plan that your organization uses.
      Prerequisite:
      You must have explicit access to the API or the API must belong to your organization.
  6. If any of the APIs that you have added to the application use OAuth, in the
    Authentication and Credentials
    section, complete the following fields:
    • Callback/Redirect URL(s)
      Defines the callback/redirect URLs for your application. Separate multiple URLs using a comma.
      https://{yourportalurl}/admin/oauthCallback
    • Scope
      Defines the OAuth scope parameters that specify the privileges that this application requires from the protected APIs. Separate parameters using a space.
    • Type
      Defines the grant type for the OAuth-protected APIs that the application consumes.
      Values:
      • None
      • Public:
        Defines that the OAuth-protected APIs that this application consumes use the Implicit grant type.
      • Confidential:
        Defines that the OAuth-protected APIs that this application consumes use the Confidential grant type.
      Default:
      None
    • Shared Secret Format
      Determine the format for the shared secret for this application.
      Values:
      • Plain text secret:
        Generate the secret in plaintext format.
      • Hashed secret:
        Generate the secret in hashed format.
      Depending on
      Layer7 API Developer Portal
      settings, Plain text Secret and/or Hashed Secret formats might be available.
      For more information about hashed secrets, see Enable Hashed Client Secret.
  7. Select
    Save
    .
The application is added.
Edit an Application using API Hub
Follow these steps:
  1. Sign in to API Hub as Portal Admin, API Owner, Org Admin, or Org Publisher.
  2. From the list of applications, for the application that you want to edit, click the ellipsis in the tile, and then select
    Edit
    .
    The Application Details page appears in edit mode.
    You can also access this page by clicking
    Edit
    (the pencil icon) while viewing the page in view-only mode.
  3. Edit the application, and then select
    Save
    .
Your changes are saved.
Generate a New Secret for an Application using API Hub
For those application to which you have access, you can generate a new secret for your application, for example, if the shared secret is compromised.
Generating a new secret changes the API key and voids the current API key. This breaks access for anyone using the current API key. Share and use newly-generated secrets with developers coding their application that uses the APIs.
Follow these steps:
  1. While logged in to API Hub as Portal Admin, API Owner, Org Admin, or Org Publisher, from the Application Details page, click
    Generate New Secret
    , and then click
    Plain text secret
    or
    Hashed secret
    .
    For more information about hashed client secrets, see Enable Hashed Client Secret.
    The Generate New Secret window opens.
  2. Click
    Generate New Secret
    .
  3. Save your changes.
Delete an Application using API Hub
Follow these steps:
  1. Sign in to API Hub as Portal Admin, API Owner, Org Admin, or Org Publisher.
  2. From the list of applications page, for the application that you want to delete, click the ellipsis in the tile, and then select
    Delete
    .
  3. Confirm the deletion by selecting
    Delete
    .
The application is deleted.