Oracle® Fusion Middleware
Installing the API Gateway

This topic describes how to install the API Gateway on the following platforms:

System Requirements

See the System Requirements to ensure that the target machine is of a suitable specification. For details on API Gateway components and concepts, see the Oracle API Gateway User Guide.

When you run the installation executable in default GUI mode, you are presented with an introductory welcome screen. Click Next to continue with the installation.

Enter or click Browse to specify the directory where you wish to install API Gateway components, for example:

Click Next to continue.

Select the components that you wish to install, or deselect those that you do not wish to install:

Click Next to continue.

Select whether this is the first system in a new API Gateway domain. Defaults to Yes, which configures the system with a new Admin Node Manager.

If you select No, the system is configured with a local Node Manager, which connects to an existing Admin Node Manager. You are asked to enter the connection details to an existing Admin Node Manager.

Click Next to continue.

If you selected Yes in the Domain Connection screen, configure the following settings. Otherwise, skip to the section called “Local Node Manager Details”.

Use SSL/HTTPS Scheme for Connection:

Select whether to use SSL/HTTP to connect to the Node Manager. This setting is selected by default.

Hostname or IP Address:

Select a host address from the Autodetected List (defaults to the installation hostname), or choose Select Manually, and enter a host address.

Local Management Port:

Enter the local port used to manage the Node Manager. Defaults to 8090.

Click Next to continue.

If you selected No in the Domain Connection screen, configure the following settings:

Use SSL/HTTPS Scheme for Connection:

Select whether to use SSL/HTTP to connect to the Node Manager. This setting is selected by default.

Hostname or IP Address:

Select a host address from the Autodetected List (for example, 127.0.0.1), or choose Select Manually, and enter a host address.

Local Management Port:

Enter the local port used to manage the Node Manager. Defaults to 8090.

Click Next to continue.

If you selected No in the Domain Connection screen, configure the following settings to connect to an existing Admin Node Manager. Otherwise, skip to the next section.

Connection URL:

Enter the URL to connect to the Admin Node Manager. Defaults to the following:

https://[admin-node-hostname-or-IP]:8090

Modify Default Values?:

Select whether to modify the default Admin Node Manager username/password (admin/changeme). When this is selected, enter a new username/password. This setting is unselected by default.

Click Next to continue.

Configure the following settings:

Add a Service for the Node Manager:

Select whether to add a service for the Node Manager. Defaults to No.

Run Service as non default user:

Select whether to run the Node Manager service as a non-default user. This setting is not selected by default. When you select this setting, you can enter a non-default user in the Username field. The default user is admin.

Click Next to continue.

Select whether to configure a new API Gateway instance. Defaults to Yes. When Yes is selected, you are asked to enter connection details for the new API Gateway instance in the next step.

Click Next to continue.

If you selected to configure a new API Gateway instance in the previous step, configure the following settings. Otherwise, skip to the section called “Ready to Install”.

API Gateway Name:

Enter a name for the API Gateway instance. Defaults to Gateway1.

API Gateway Group:

Enter a group name for the API Gateway instance. Defaults to Group1.

Use SSL/HTTPS Scheme for Connection:

Select whether to use SSL/HTTP to connect to the API Gateway instance. This setting is selected by default.

Local Management Port:

Enter the local port that the Node Manager uses to manage the API Gateway instance. Defaults to 8085.

External Traffic Port:

Enter the port that the API Gateway uses for message traffic from external clients. Defaults to 8080.

Click Next to continue.

If you selected to configure a new API Gateway instance, you can configure the following settings:

Add a Service (/etc/init.d script) for the API Gateway Instance:

Select whether to add a service for the API Gateway instance. Defaults to No.

Run Service as non default user:

Select whether to run the Node Manager service as a non-default user. This setting is not selected by default. When you select this setting, you can enter a non-default user in the Username field. The default user is admin.

Click Next to continue.

Select whether to start the Admin Node Manager and the new API Gateway instance after installation. Defaults to Yes (recommended).

Click Next to continue.

The installer is ready to start installing the selected components and settings on your system.

Click Next to continue.

A progress screen is displayed showing the progress of the installation of files. Please wait for the installation to complete.

Click Next to continue.

After the installer has finished, you can connect to the Admin Node Manager using the connection URL. You can also select whether to connect to the Policy Studio if this was installed.

Click Finish to complete the installation. You can access the API Gateway Manager tools in your browser. The default URL is displayed in the dialog (https://hostname:8090/).

Click OK to finish. Policy Studio also launches if this was selected.

If you did not select to start the API Gateway after installation, you can start the API Gateway as follows:

If you did not select to launch the Policy Studio automatically after installation, see the section called “Starting the Policy Studio”.

You can run the API Gateway installer in unattended mode on the command line. The following command shows an example of installing the API Gateway component only:

Windows

OAG-11.1.2.1.0-windows-installer.exe --mode unattended 
  --enable-components nodemanager --disable-components analytics,policystudio

Linux

./OAG-11.1.2.1.0-linux-installer.run --mode unattended 
  --enable-components nodemanager --disable-components analytics,policystudio

The specified components are installed in the background.

Further Information

For a description of all available command options and default settings, enter the --help option. This outputs the help text in a separate console.

If you wish to create a new managed domain and API Gateway instance, you can do this using the managedomain script. For more details, see Configuring a Managed Domain.