Layer7 API Developer Portal - 4.5

PDF
index saas 5.0 4.5 4.4 4.3.2 4.3.1 4.2
English

Create and Set Permissions for APIs

This article includes information about how to create APIs and set up API management permissions and visibility.
2
Create an API
This article includes information about how to create APIs and set up API management permissions and visibility.
Follow these steps:
  1. Log in to API Developer Portal as an administrator.
  2. Select
    Publish
    .
    A list of APIs appears.
  3. Select
    Add API
    .
    A new
    Publish an API
     window opens.
  4. In the
    API Definition
     section, choose between
    REST
     and
    SOAP
     API types.
  5. If applicable, select
    Choose file
     to upload your Swagger or WADL definition files (for REST API), or WSDL file and optional XSD file (for SOAP API). For more details, see About API Description Files. If you do not have any definition files, provide API details manually in the next step.
  6. Click
    Next
    .
    The
    API Details
     section opens.
  7. If you uploaded an API definition file, the fields are already filled with values. You are alerted to any mandatory fields that do not have assigned values.
    Provide values as follows:
    Field
    Notes
    API Name
    Maximum name length is 255 characters. Name must be unique.
    Version
    The value for this field can only contain 0-9 and be delimited with . _ and - characters.
    Location of API
    The API proxy routes requests from applications to the location of the API behind the API proxy. Developers do not see this information. Use a context variable to Route the API to Multiple Data Centers.
    API EULA
    Select an available End User License Agreement (EULA). Before developers can get an API key for the API, they must agree to your EULA.
    Public Description
    Optional. The description appears in the API Explorer and Add/Edit Application wizards. Use this field to provide developers with API information such as its proxy URL and authentication requirements. Maximum description length is 255 characters.
    Private Description
    Maximum description length is 255 characters.
    API Explorer is only accessible through the API Portal/Ingress tenant.
  8. Click
    Next
    .
    The
    Proxy Configuration
     section opens.
  9. Complete the
    Proxy URL
    , which is the public URL of the API on the API proxy. Developers use this URL in their applications to send requests to the API.
    For
    Policy Templates
    , select a policy template, select
    Add
    , and then set its parameters. You can combine multiple policy templates. If you select multiple policy templates, ensure that you select them in the order that you want the API Proxy to apply them. For more information about how to control API access with policy templates, see Policy Templates.
  10. Click
    Next
    .
  11. (Only for REST APIs) The
    Spec Authentication
     section opens. Select
    Authentication type
    . The selected Authentication type is used in the
    Spec
     tab of the details page when trying out the API.
  12. Click
    Create
    .
The API is created.
A new window opens. Set up API Management and visibility permissions.
Set Up the API Management Permissions
Set up who has the permissions to edit and delete this API.
Follow these steps:
  1. Select who can manage the API. You must specify a Managing Organization or at least one API Owner.
    1. Select the Managing Organization
       - Selecting a managing organization allows all users within that organization to edit this API. This only applies if the user has permissions to edit APIs.
      If you are upgrading from version 4.4 or earlier, note the following:
      In previous versions of API Portal, the association of APIs and Organizations was either direct or indirect.
      • Direct association = you could only select one organization for the API.
      • Indirect association = you could attach the API to an account plan, then add multiple organizations to the account plan.
      What happens after the upgrade to version 4.5:
      • If the association of an API and Organizations was direct, the organization that was assigned to the API is now the Managing Organization.
      • If the association of an API and Organizations was direct, there is no Managing Organization associated with the API. If you want to assign a Managing Organization, edit the Management permissions of the API.
    2. Select API Owner Permissions
      1. Open - Anyone with API management permissions can edit this API.
      2. Restricted - Specify users with API management permissions to edit this API.
      Note the following:
      If an Admin or an API Owner created an API in version 4.4 and assigned an Org User to the user permission list:
      • After the upgrade to 4.5, only the Portal Admin or the API Owner who belong to the permissions list will have access to manage this API.
      • An Org User who was a part of the permissions list will gain or lose the API management permissions based on the number of Organizations associated with this API. If there were multiple organizations assigned, the Org User will lose the API management permissions.
  2. Select
    Restricted
    .
    A list of API Owners appears.
  3. Select the users that have permission to edit and delete the API.
    The selected users appear in the right column
    Selected
    .
  4. Click
    Save &
    Next
    .
API Management permissions are updated. You have successfully selected the users that can edit and delete the API.
Set Up the API Visibility Permissions for Your Organizations
Follow these steps:
  1. Choose the level of visibility of the API for your Organizations:
    1. Public
       - The API is visible to all organizations. If you set the visibility to
      Public
      , any API Owner added in the future will automatically see this API.
    2. Private
       - The API is visible only to you. If you are part of an organization, the organization can see the API as well. API Owners can still see this API regardless of the settings. Set up which organizations can see this API. If you are not part of an organization and creating a private API, then only API owners will be able to see it.
      If an administrator or an API Owner selects Private, the API is not associated with any organization.
    3. Restricted
       - Specify which organizations can see this API. If you set the visibility to
      Restricted
      , existing API Owners can still see this API but any new API Owners will need to be added manually to be able to see this API.
  2. Select
    Restricted
    .
    A list of available Organizations appear.
  3. Check the box next to each Organization Name for the organizations that have permission to see the API.
    The selected organizations appear in the right column
    Selected
    .
  4. Click
    Next
    .
Visibility permissions are updated. You have successfully selected the organizations that can see the API.
Add Tags to the API
After creating an API, you can add tags to the API to group similar APIs together for improved filtering. Users can then search and discover APIs according to their visibility permissions.
You can add up to 25 tags to an API. Maximum length of the tag is limited to 60 characters.
Follow these steps:
  1. Click
    Tags
     to open the Tags screen.
    All the tags that are imported from Swagger and those available in Portal are listed.
  2. Select the tags that you need to associate with the API.
    The tags are added to the
    Selected
     column.
    Note:
     Click
    Select swagger tags
     to select all the tags that are imported from Swagger with a single click.
  3. To add a new tag, type the tag in the
    Enter tag name
     field and click
    Add New Tag
    .
    The new tag is added and it is automatically selected to be associated with the API.
    Only the following characters are allowed in tags:
    alphanumeric  space  '  "  _  -  .  #  :
  4. Click
    Save
    .
    All the selected tags are now associated with the API.
Set Up Publish State
Follow these steps:
  1. In the
    Publish State
     section, select:
    • Incomplete - The API is incomplete.
    • Enabled - The API will be published. Add applications right away.
    • Disabled - Cannot add applications and deploy to proxies.
    • Deprecated - Cannot add applications and deploy to proxies.
    • Unpublished - This setting is only available to Gateway-published APIs.
  2. Click
    Save
    .