Contents
This topic shows the preliminary steps required before you begin working through the Getting Started tutorial. It explains how to start the API Gateway, the web-based API Gateway Manager tools and the Policy Studio. Finally, this topic shows the main steps in the Getting Started tutorial.
Before you start the API Gateway tools, do the following:
Check System Requirements
You should ensure that your target machine and platform are supported.
Install the API Gateway and Policy Studio
If you have not already done so, see the Oracle API Gateway Installation and Configuration Guide.
Configure a Managed Domain
If you have not already created a domain, you can use the managedomain
script to configure a domain. You should also ensure that the Admin Node Manager is running.
Create the API Gateway Instance
If you have not already created a domain, you can use the managedomain
script create the API Gateway Instance. For more details, see the Oracle
API Gateway Installation and Configuration Guide.
To access the web-based API Gateway Manager tools, perform the following steps:
![[Note]](../common_oracle/images/admon/note.png) |
Note |
|---|---|
|
You must ensure that the Admin Node Manager is running before you can access the web-based API Gateway Manager tools. |
-
Enter the following URL:
https://HOST:8090/
HOSTrefers to the hostname or IP address of the machine on which the API Gateway is running (for example,https://localhost:8090/). -
Enter your user name and password. The default values are as follows:
-
Click the appropriate button in the API Gateway Manager screen in the browser. The Dashboard view is displayed by default.
The API Gateway Manager includes the following main views:
-
Dashboard: overall system health, message traffic summary, and topology (domain, hosts, API Gateways, and groups).
-
Monitoring: real-time monitoring of all the traffic processed by the API Gateway. Includes statistics at the system level and for services invoked and remote hosts connected to.
-
API Service Manager: enables you to manage API services, Web services, and policies (for example, virtualize services, and assign policies to them).
-
Traffic: a message log of the HTTP, HTTPS, JMS, and FTP traffic processed by the API Gateway.
-
Logs: API Gateway trace log, audit log, and access log files.
-
Events: API Gateway log points, alerts, and SLA alerts.
-
Settings: Enables you to configure dynamic API Gateway logging.
To start Policy Studio, perform the following steps:
-
In your Policy Studio installation directory, enter the
policystudiocommand. -
In the Policy Studio, click a link to connect to the Admin Node Manager session.
-
In the Open Connection dialog, click OK to accept the default settings. For more details, see Connection Details.
-
The Oracle API Gateway instance is displayed in the Topology view.
-
In the Topology view, double-click the Oracle API Gateway process to load the configuration for the active API Gateway.
-
If a passphrase has been set, enter it in the Enter Passphrase dialog, and click OK. Alternatively, if no passphrase has been set, click OK.
Policy Studio enables you to perform the full range of API Gateway configuration and management tasks. This includes tasks such as create and assign policies, import Services, optimize API Gateway configuration settings, and manage API Gateway deployments. For more details on using the Policy Studio to manage API Gateway processes and configurations, see Getting Started with Managing Deployments.
When you have completed the preliminary steps, and started the API Gateway components, you can then start working through the Getting Started Tutorial. This tutorial is based on a simple Apache Axis Service. It includes the following main steps:
