Use Private APIs

In some cases, you may want to designate one or more APIs to be "private" in order to restrict access. For example, you may want to Beta test an API with a small group of Developers before making it more widely available, or you may want to make certain APIs available only to internal Developers, or specific partners. 
apidp35-3-5
In some cases, you may want to designate one or more APIs to be "private" in order to restrict access. For example, you may want to Beta test an API with a small group of Developers before making it more widely available, or you may want to make certain APIs available only to internal Developers, or specific partners. 
 
Tip: 
You can also make an API private while enabling it (see Enable APIs).
 
To designate an API as private: 
 
  1. On the Dashboard, select 
    APIs
    .
  2. Select the check box next to the API(s) to make private.
  3. In the Actions menu at the bottom, choose 
    Set 
     
    to
     
    Private
     and then click 
    Apply
    .
    The status of the API(s) is set to Private.
    Note:
     If a WADL was uploaded, the API will no longer be available to API Portal users in the API Explorer API list. To make the API available to Portal users, you must grant them access. For details, see Assign/Remove Access to Private APIs.
Private API Documentation
You can associate API documentation on the Portal with a Private API, effectively making that documentation page invisible to Portal users. In order to do this, you must have access to the CMS of API Portal. For more information on the CMS.
 
To associate API documentation with a Private API:
 
  1. Log in to the CMS as an 
    Administrator
     or 
    API
     
    Owner
    . The API Portal CMS appears. For log in directions, see Get Started with the API Portal.
  2. Choose 
    Staging
     at the top of the browser. 
  3. Navigate to the documentation page that you want to associate with the private API. 
  4. Point to the Layer 7 icon at the right and then select 
    Edit 
     
    API 
     
    Document
    Standalone
    . The API Document Editor appears.
  5. From the 
    API
     menu, choose the private API you want to associate with this page. 
  6. Click 
    Save
Now the API document page cannot be viewed by anonymous users of the API Portal or by any user who is denied access to the private API. To make the API documentation available to Portal users, you must grant them access to the private API. For details, see Assign and Remove Access to Private APIs.
Private API Forums
When an API is set to Private, the forums associated with it are set to Private as well, effectively making that forum invisible to Portal users.
Private forums cannot be viewed by anonymous users of the API Portal or by any user who is denied access to the private API. To make the forum available to Portal users, you must grant them access to the private API. For details, see Assign and Remove Access to Private APIs.
Assigning/Removing Access to Private APIs
You can grant organizations access to private APIs. All of that organization's users will then have access to:
  • API documentation associated with the private API
  • Forums associated with the private API
  • API Explorer capabilities for the private API
 
To assign access to a private API:
 
  1. On the Dashboard, select 
    Organizations
    .
  2. Select the check box next to the organization(s) to be granted access. 
  3. From the 
    Actions
     menu, choose 
    Assign 
     
    Private API
     and then click 
    Apply
  4. Select one or more private APIs from the list. Tip: Hold down the 
    Ctrl
     key to select more than one line. 
  5. Click 
    Add
    . The selected APIs are displayed under "Assign APIs". 
  6. Click 
    Apply
    .
    All of the organizations you selected now have access to the private APIs you assigned. 
 
To remove access to a private API:
 
  1. From the Dashboard, select 
    Organizations
    .
  2. Select the check box next to the organization(s) to remove access.
  3. From the 
    Actions
     menu, choose 
    Remove Private AP
    I and then click 
    Apply
  4. Select the private API(s) to remove from the list. 
  5. Click 
    Remove
    . The selected APIs are displayed under 
    APIs to be removed
  6. Click 
    Apply
All of the organizations you selected no longer have access to the private APIs you removed.