1.2 Understanding the Secure API Manager Components

Secure API Manager is an add-on solution for Access Manager that controls API authorizations, API creation, and API management in development and production environments. The following graphic depicts the different components of Secure API Manager.

Figure 1-4 Secure API Manager Architecture

Secure API Manager consists of one appliance or a Docker container that you deploy that integrates closely with Access Manager to provide all of the functionality required to manage and control access to the APIs.

  • Administration: Secure API Manager Administration Console is integrated with the Access Manager Administration Console. You use the Access Manager Administration Console to perform the administration tasks for Secure API Manager. For more information, see Welcome to Secure API Manager in the NetIQ Secure API Manager 2.1 Administration Guide.

  • Analytics: Secure API Manager uses the Access Manager Analytics Server to provide analytics about the APIs. You view and manage the API analytics through the Access Manager Administration Console. For more information, see Configure Analytics in the NetIQ Secure API Manager 2.1 Administration Guide.

  • API Gateway: Secure API Manager includes an API Gateway that contains the APIs in a run-time state. The API Gateway either authorizes the API execution if the call contains the proper information or it rejects the API call. When you deploy Secure API Manager, you are deploying the API Gateway and the supporting items to Access Manager. For more information, see Section 3.0, Deploying Secure API Manager.

  • Identity Server: Secure API Manager uses the Access Manager Identity Server to authorize the API calls through OAuth tokens. For more information, see How Secure API Manager Authorizes APIs.

  • Publisher: The Publisher is a web application that Secure API Manager provides for the API developers. It is a separate console from the Access Manager Administration Console for security purposes. The API developers are usually not Access Manager administrators. The Publisher allows the API developers to create, manage, and publish the APIs. The Store is where the API developers access and use the APIs.

    The default, no one has access to the Publisher. You must grant access to the Publisher. For more information, see Grant Access to the Publisher and the Store in the NetIQ Secure API Manager 2.1 Administration Guide.

  • Store: The Store is a web application for API developers or partners that Secure API Manager provides. It allows the API developers to see all of the available APIS and to subscribe and use the APIs. The Store makes the APIs created in the Publisher available for use for API developers and partners. The API developers and partners subscribe to the APIs to use them. The Store does not allow the developers to create new APIs.

    By default, no one has access to the Store. You must grant access to the Store. For more information, see Grant Access to the Publisher and the Store in the NetIQ Secure API Manager 2.1 Administration Guide.