Configure API Manager

Overview

This topic describes the steps required to configure the API management features available in Oracle API Manager.

Note   API Manager is enabled by default when you install the Quick Start tutorial. You only need to enable API Manager if you did not install the Quick Start tutorial.

Prerequisites

Before you begin, ensure the following:

  1. Ensure that Oracle API Gateway is also installed. API Manager is a layered product running on API Gateway, which provides the underlying gateway capabilities. API Gateway is a prerequisite product for API Manager.
  2. Ensure that an API Gateway Admin Node Manager and an API Gateway instance have been created and started.

For more details, see the API Gateway Installation Guide.

Enable API Manager

If you selected to install API Manager and the Quick Start tutorial, API Manager is enabled by default, and you can skip to the next section. However, if you installed API Manager, but did not install the Quick Start tutorial, you must perform the following steps:

  1. Change to the following directory:

Windows

Linux/UNIX

  1. Run the following command

For example:

For more details on available options, enter the following:

  1. Enter the API administrator password that you specified when installing API Manager.
  1. After the script completes, the API Gateway instance restarts automatically.

Log into API Manager

  1. Enter the following URL in your browser:
  1. Log in using the API administrator credentials that you specified when installing API Manager, or when prompted by setup-apimanager.
Note   For security reasons, it is recommended that you change the default credentials. For more details, see Administer APIs in API Manager.

Configure a monitoring database

To monitor and report on APIs in API Manager, you must perform the following steps:

  1. Configure a JDBC-compliant database used to store historic reports. The following databases are supported:
    • Oracle
    • MySQL
    • Microsoft SQL Server
    • IBM DB2
  3. Configure the API Gateway for monitoring. For example, you must ensure that real-time monitoring is enabled on the API Gateway, and that writing metrics data to the database is enabled.

For more details, see the API Gateway Installation Guide.

Further information

For more details on API Manager configuration, see the following topics: