View the APIs and Applications on the Developer Console

You can view the applications and APIs that the API Owner or Portal Admin creates on the Developer Console.
You can view the applications and APIs that the API Owner or Portal Admin creates on the Developer Console.
In this article:
2
2
View All APIs
Follow these steps:
  1. Log in to
    API Portal
    as an Org Admin or Developer.
  2. From the menu bar, select
    Manage
    ,
    APIs
    .
    The
    APIs
    page opens showing all the APIs. This page displays a list of all the APIs along with each API's state (Available or Unavailable). APIs in the "Available" API state have been deployed on the Gateway. APIs in the "Unavailable" API state are pending deployment on the Gateway.
  3. To view the Swagger UI for the API, click
    Spec
    .
    • If the API includes a Swagger file, a parsed Swagger file is displayed on the right side of the page. In the
      Resources
      section, you can select a link that jumps to the associated Argument in the middle of the page and to the associated definition in the parsed Swagger file.
      If you select a Web Application Description Language (WADL) or Swagger file in the API Definition and you want to expose your Proxy URL to Developers, ensure that the file includes the Proxy URL information.
    • If the API does not include a Swagger file, the right side of the page is blank. In the
      Resources
      section, each Proxy URL for the API is listed. In the middle of the page, each Proxy URL and its API deployment status is displayed. You can copy the Proxy URL from this section and use it as required.
  4. If the API includes a Swagger file, to download the Swagger file, click
    Swagger File
    .
  5. To add the API to an application:
    1. Click
      Use API
      .
      A drop-down list of applications displays.
    2. Select the application to which you want to add the API, and then click
      Accept
      .
      A check mark beside the application indicates that the API is already added to the application. The EULA is displayed.
      The App details page opens showing the APIs that have been added to the application.
View All Applications
Follow these steps:
  1. While logged in to
    API Portal
    as an Org Admin or Developer, from the menu bar, select
    Manage
    ,
    Applications
    .
    The
    Applications
    page opens showing all the APIs. This page displays a list of all the applications along with each application's state (Available or Unavailable). Applications in the "Available" state have been deployed on the Gateway. Applications in the "Unavailable" state are pending deployment on the Gateway.
  2. Select an application.
    The application page opens to the
    Configuration
    tab, where you can view a list of the API keys that have been added to the application. You can view the following application details:
    Configuration Field
    Description
    API Key (Client ID)
    Uniquely identifies the consuming the API.
    Read-only:
    Yes
    Shared Secret
    Displays the credentials for API authentication.
    Read-only:
    Yes
    Status
    The application's state. Applications in the "Enabled" state indicate that you can get an API key and that you can see it in API Explorer. Applications in the "Disabled" state indicate that you do not have permissions to interact with the APIs that have been added to the application.
    Read-only:
    Yes
    OAuth Callback URL(s)
    The authentication mechanism for consuming the API.
    Read-only:
    Yes
    OAuth Scope
    The authentication mechanism for consuming the API.
    Read-only:
    Yes
    OAuth Type
    The authentication mechanism for consuming the API.
    Read-only:
    Yes
  3. To view the APIs that have been added to the application, click the
    APIs
    tab.
  4. To add more APIs to the applications, select
    Actions
    ,
    Edit API Assignment
    .
  5. To view and edit the application, select
    Actions
    ,
    Edit Application
    .
    The
    Details
    page opens and displays the fields described in the following table.
Notes about using Search
Search for APIs by entering a partial or full name of the API you are looking for.
Use search:
  • To help you find APIs and content on custom pages (pages that your Admin publishes using the content management system).
  • To find exact matches, and partial matches in titles, names, descriptions, and other content.
  • Search does not find content on standard pages (for example, Applications and Analytics pages).
  • Search does not support Boolean searches (operators like AND, NOT and OR to get more relevant results).