Discovering APIs using API Portal

Version 7

     

    Introduction to API Portal

     

    API Portal Overview

    API Portal provides API consumers with secure access to managed APIs. API consumers can see details for a managed API such as status, authentication type, and applicable access control policy, and drill down to further details with SWAGGER or WSDL.

     

    API consumers can also use the API Portal to interact with managed APIs and view API usage analytics.

     

    Before you can access the API Portal, you must obtain Informatica Intelligent Cloud Services login credentials from the organization administrator.

     

    Before you Start

    Before you use API Portal, ensure that you have an active Informatica Intelligent Cloud Services account for the organization and have an API Manager license.

     

    To access API Portal, the organization administrator must assign the user the Service Consumer privilege.

     

    For more information about registration and roles, refer to the Informatica Cloud Administrator Guide.

     

    Note: A trial subscription includes access to API Portal during the trial period.

     

    Accessing API Portal

    Access API Portal from the Informatica Intelligent Cloud Services service picker.

    1. On the Informatica Intelligent Cloud Services login page, enter your user name and password.
    2. Click Log In. The Informatica Intelligent Cloud Services service picker appears.
    3. Select API Portal. The API Portal application appears.

     

    API Registry

     

    API Registry Overview

    Use API Portal to securely view details for organization managed APIs. You can copy the URL of any managed API and use it in your own applications.

     

    API Portal displays details for organization managed APIs such as status, authentication type, and applicable access control policy. You can use API Portal to access Swagger for REST managed APIs and WSDL for SOAP managed APIs. You can also use the API Portal to test and debug API execution.

     

    Viewing Managed APIs

    Use the API Registry page of the API Portal to view managed APIs.

     

    The API Registry page shows managed APIs in alphabetical order. sort the managed APIs, click the title of the column to sort.

     

    If a managed API exists for a service that is unavailable or has been deleted, the managed API is grayed out in the display.

     

    API Registry Properties

     

    The following table describes the API Registry page properties:

     

    Property
    Description
    Icon

    Icon identifies whether the entity is a service or managed API:

    • Designates a service.
    • Designates a managed API.
    NameName of the service or managed API.
    Protocol

    The protocol of the service or the managed API:

    • REST
    • SOAP

    Informatica Cloud Application Integration services are published with both REST and SOAP endpoints.

    Status

    Status of a managed API:

    • Active: The managed API is active.
    • Inactive: The managed API is not active.
    • Service not available: This status indicates a managed API for a service that is unavailable or deleted.

    If the service for which a managed API has been created is unavailable or deleted, the managed API is grayed out.

    Antentication

    API authentication method:

    • Basic Auth: Basic authentication. The API consumer must provide an Informatica Cloud user name and password.
    • Anonymous: The API does not require the API consumer to authenticate.
    Rate LimitAn individual rate limit policy for a managed API.
    DescriptionDescription that the Informatica Cloud Application Integration developer provided for the service.

     

    Obtaining a Managed API URL

    Copy the URL of the managed API and use it in your applications to invoke the API.

    1. In the API Registry page, select a managed API.
    2. Click to open the Actions menu, and select Copy URL. The URL is copied to the clipboard

     

    Viewing Managed API Details

    You can view various details of the managed API, including the URL.

     

    In the API Registry page, click to select a managed API. The Managed API Details window appears and displays relevant details.

     

    Viewing Managed API Metadata

    Use the URL of the managed API to view its metadata.

    1. In the API Registry page, select a managed API.
    2. Click in the right-most column to open the Actions menu, and select View API Details. The Managed API Details window appears.
    3. To view metadata details for the managed API, select the available option:
      • To view details for a REST API, click Swagger.
      • To view details for a SOAP API, click WSDL.

     

    Searching for a Managed API

    You can search for a managed API by sorting columns or searching for specific text.

    1. To sort the managed APIs according to a specific property, in the API Registry tab, click the column picker icon to the left of the Find field and then select the column to sort. The API Registry table shows the sorted managed APIs.
    2. To search for managed APIs according to specific text, in the Find field, type the text that you want to search for. The search is performed on all columns. The API Registry table shows the relevant managed APIs.

     

    Interactively Testing a Managed API

    You can interactively test a managed API created for a REST API in a Swagger interface. You can view the API URL, the HTTP status codes, the request parameters, and the response parameters. You can also execute the API for testing purposes, or get a sample curl command.

    1. In the API Registry page, click to select a managed API. The Managed API Details window appears.
    2. Select the Swagger tab.
    3. If the API requires authentication, the Authorization dialog box appears. Enter the username and password of a user who is authorized to access the API.
    4. To expand the view in the Swagger tab, click the arrows in the upper right corner.
    5. To view the API request body and response codes, click any button that displays an API method. For example, for an API with a POST method, a POST button is displayed. Click the POST button to view the API request body.
    6. To view the request body in JSON format, select application/json. To view the request body in XML format, select application/xml.
    7. To test the API semantics, in the request body panel, perform the following steps:
      • Click Try it out.
      • Edit the request body. Replace any parameter type with a value.
      • To test the updated request body, click Execute. The Server response panel displays the response body, response headers, and request duration time.
      • To clear the server response, click Clear.
      • To cancel the request body changes, click Cancel. To change the request body again, click Edit.
    8. To view the request or response syntax, in the Models panel, click the right arrow near the request or response entry. The model request or response body is displayed. A red asterisk next to an element indicates a required element.

     

    Analytics

     

    Analytics Overview

    API analytics provides a graphical overview of activity and API usage. The Analytics dashboard contains panels with reports about managed APIs. Use the dashboard to view visual summary information about APIs, such as trends in usage over time and APIs with the most invocations.

     

    You can view your API usage activity for any authenticated managed API. You can see which authenticated managed APIs are most frequently invoked on your behalf.

     

    Note: Analytics are based on the user name that is provided as part of the Authorization HTTP header in an authenticated API. The statistics reflect the number of API invocations executed for each API which contains your user name in the Authorization header.

     

    Analytics

    You can use the Analytics page to view graphical summary information about APIs, such as trends in usage over time and APIs with the most invocations.

     

    The Analytics page shows API usage trends for a selected period, for 7, 30, or 90 days. You can refresh the data by clicking the refresh icon. The last time that you refreshed the data is displayed near the icon.

     

    Note: Data from the current day appears after a delay of half an hour.

     

    You can also view the APIs most frequently invoked in the selected period, ranked by number of invocations. To sort the display, click the title of the column to sort.

     

    Analytics Properties

    The following table describes the properties of the My Top APIs report in the Analytics page:

     

    PanelDescription
    API NameName of the managed API.
    API URLIdentifies the URL of the managed API that was invoked.
    Protocol

    Identifies the protocol of the managed API. The type property has the following options:

    • REST
    • SOAP
    Invocations

    Number of times that your user invoked URLs for authenticated managed APIs.

    Note: Analytics are based on the user name that is provided as part of the Authorization HTTP header in an authenticated API.