View All APIs and Applications on the Developer Console

The Develop function on the Portal main menu opens the Developer Console where you can view all the applications and APIs created by the API Owner or Publish Admin. When you enter the Develop page, you can search for APIs by entering a partial or full name of the API you are looking for. You can also select View All APIs to view a complete list of APIs.
apip42
The
Develop
function on the Portal main menu opens the Developer Console where you can view all the applications and APIs created by the API Owner or Publish Admin. When you enter the Develop page, you can search for APIs by entering a partial or full name of the API you are looking for. You can also select
View All APIs 
to view a complete list of APIs.
This page describes the following features in the Developer console:
2
2
View All APIs
On the View All APIs page, a list of all the APIs is displayed along with each API's state (Available or Unavailable). An Available API state means that the API has been deployed on the Gateway. An Unavailable API state means that the API is pending deployment on the Gateway.
To view all the APIs on the Developer console:
  1. On the Develop page, select 
    View all APIs
    .
    A page opens showing all the APIs.
  2. Place your cursor over an API, and click 
    View Documentation
    . The page opens displaying information for the selected API. 
    • If a Swagger file was selected in the API Definition, 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 WADL or Swagger file in the API Definition and you want to expose your Proxy URL to developers, make sure the file contains the Proxy URL information.
    • If a Swagger file is not attached to the API, the right side of the page is left 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. 
  3. If a Swagger file is attached to the API and you want to download the Swagger file, click the 
    Swagger File 
    button.
  4. To attach the API to a specific application, click 
    Use API 
    to display a drop-down list of applications and select one from the list. A check mark beside the application means that the API is already attached to the application. When an App is selected, the EULA is displayed. Click 
    Accept
    , and the App details page opens showing all the APIs attached to the App.
View All Applications
On the View Applications page, a list of all the applications is displayed along with each application's state (Available or Unavailable). An Available application state means that the application has been deployed on the Gateway. An Unavailable application state means that the application is pending deployment on the Gateway.
To view all the applications on the Developer console:
  1. On the Develop page, select
    View All Applications
    .
    A page opens showing all the applications.
  2. Select an application.
    The application page opens in the 
    APIs 
    tab, where you can view all the APIs attached to the application. 
  3. Select 
    Browse additional APIs 
    to add more APIs to attach to the application. 
  4. To view and edit application information, select the 
    Configuration 
    tab. The Configuration page opens and displays the fields described in the following table.
    Configuration Field
    Description
    App Name
    The name of the application.
    Client ID/API Key
    A read-only field, used for uniquely identifying and consuming the API.
    Shared Secret
    A read-only field to display the credentials for API authentication.
    State
    The Portal state. 
    Enabled 
    indicates you can get a key and will be able to see it in API Explorer. 
    Disabled 
    indicates you have no permissions to interact with the API.
    OAuth Callback URL(s)
    The authentication mechanism for consuming the API.
    OAuth Scope
    Shared Secret
    The type of shared secret (None, Public, or Confidential).
    Your configuration updates are saved automatically when you exit the page.