Go to main content
1/14
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Conventions
Part I Introduction to Oracle API Manager
1
Introducing Oracle API Manager
1.1
What is Oracle API Manager?
1.2
Understanding Oracle API Manager Features
1.3
Understanding User Roles in Oracle API Manager
1.4
Getting Started with Oracle API Manager
Part II Installing and Configuring Oracle API Manager
2
Installing Oracle API Manager
2.1
Planning the Installation
2.1.1
Product Distribution
2.1.2
Verifying Certification, System Requirements, and Interoperability
2.1.2.1
Verifying Your Environment Meets Certification Requirements
2.1.2.2
Using the System Requirements Document to Verify Certification
2.1.2.3
Verifying Interoperability Among Multiple Products
2.2
Installing Software Required for an API Manager Installation
2.2.1
Installing a Certified JDK
2.2.2
Installing and Configuring a Certified Database
2.2.3
Installing Oracle Fusion Middleware 12c Infrastructure
2.2.4
Installing the Oracle Service Bus Software
2.3
Installing Oracle API Manager via OPatch
2.4
Installing Required Patches
2.4.1
Installing the RCU Patch
2.5
Next Steps
3
Configuring the Oracle API Manager Domain
3.1
Creating the Database Schemas
3.1.1
Installing and Configuring a Certified Database
3.1.2
Starting the Repository Creation Utility (RCU)
3.1.3
Navigating the RCU Screens to Create the Schemas
3.1.3.1
Introducing RCU
3.1.3.2
Selecting a Method of Schema Creation
3.1.3.3
Providing Database Credentials
3.1.3.4
Specifying a Custom Prefix and Selecting Schemas
3.1.3.5
Specifying Schema Passwords
3.1.3.6
Specifying Custom Variables
3.1.3.7
Completing Schema Creation
3.2
Configuring Your WebLogic Domain
3.2.1
Starting the Configuration Wizard
3.2.2
Navigating the Configuration Wizard Screens to Configure the Domain
3.2.2.1
Selecting the Domain Type and Domain Home Location
3.2.2.2
Selecting the Configuration Templates
3.2.2.3
Selecting the Application Home Location
3.2.2.4
Configuring the Administrator Account
3.2.2.5
Specifying the Domain Mode and JDK
3.2.2.6
Specifying the Database Configuration Type
3.2.2.7
Specifying JDBC Component Schema Information
3.2.2.8
Testing the JDBC Connections
3.2.2.9
Selecting Advanced Configuration
3.2.2.10
Configuring the Administration Server Listen Address
3.2.2.11
Configuring the Node Manager
3.2.2.12
Configuring Managed Servers
3.2.2.13
Configuring a Cluster
3.2.2.14
Assigning Managed Servers to the Cluster
3.2.2.15
Configuring Coherence Clusters
3.2.2.16
Creating a New Machine
3.2.2.17
Assigning Servers to Machines
3.2.2.18
Reviewing Your Configuration Specifications and Configuring the Domain
3.2.2.19
Writing Down Your Domain Home and Administration Server URL
3.3
Starting the Servers
3.3.1
Starting the Node Manager
3.3.2
Starting the Administration Server
3.3.3
Starting the Managed Servers
3.4
Next Steps
4
Managing Users in Oracle API Manager
4.1
Managing Users
4.1.1
Create Groups for API Manager Roles
4.1.2
Assign Application Roles to Groups Using Fusion Middleware Control
4.1.3
Creating API Manager Users
4.1.4
Add Groups to the Monitors Parent Group
4.1.5
Assigning Users to Groups
4.2
Next Steps
Part III Using Oracle API Manager
5
Creating Your APIs
5.1
Accessing the Oracle Service Bus Console
5.2
Creating Proxy Services to Be Published as APIs
5.3
Activating the Session
5.4
Next Steps
6
Curating and Publishing Your APIs Using Oracle Service Bus
6.1
Editing the Metadata of an API
6.2
Understanding API Status
6.3
Making an API Private
6.4
Publishing an API to the Oracle API Manager Portal
6.4.1
Deciding if an API Should Be Managed or Unmanaged
6.4.2
Changing the Status of an API to Published
6.5
Hiding an API from the API Manager Portal
6.6
Deprecating an API
6.7
Next Steps
7
Using the Oracle API Manager Portal
7.1
Introducing the Oracle API Manager Portal
7.2
Accessing the API Manager Portal
7.2.1
Signing in to the API Manager Portal
7.2.2
Logging Out of the API Manager Portal
7.3
Managing Applications
7.3.1
Creating an Application
7.3.2
Subscribing to APIs from the Subscriptions Page
7.3.3
Editing an Application Description
7.3.4
Removing Applications from the API Manager Portal
7.4
Discovering APIs
7.4.1
Finding APIs Using the Catalog Page
7.4.2
Viewing Details of an API
7.4.3
Data Displayed on API Detail Pages
7.4.4
Subscribing to APIs from the Catalog Page
7.5
Viewing Your Subscriptions
7.5.1
Viewing Your Subscribed APIs
7.5.2
Viewing APIs Subscribed to a Specific Application
7.6
Using APIs in Your Applications
7.6.1
Understanding the Difference Between Managed and Unmanaged APIs
7.6.2
Using Unmanaged APIs
7.6.3
Using Managed APIs
7.6.4
Finding an Application's Entitlement Key
7.6.5
Testing APIs
7.7
Unsubscribing from APIs
7.7.1
Unsubscribe from APIs Using the APIs Panel of the Subscriptions Page
7.7.2
Unsubscribe from APIs Using the Applications Panel of the Subscriptions Page
7.8
Next Steps
8
Administering Oracle API Manager
8.1
Viewing Subscription Statistics Using the Subscriptions Page
8.1.1
Viewing a User's Subscriptions
8.1.2
Viewing API Subscription Details
8.1.3
Using the Quick Search Features
8.2
Viewing Analytics in Oracle API Manager
8.2.1
Enabling API Analytics
8.2.2
Viewing Simple Analytics for an API
8.2.3
Viewing Detailed Analytics for an API
8.2.4
Analytics Data Displayed on API Detail Pages
8.3
Importing and Exporting APIs and API Curation Metadata
8.3.1
Exporting from an Environment
8.3.2
Sample Script for Exporting Curation Metadata
8.3.3
Importing into an Environment
8.3.4
Sample Script for Importing Curation Metadata
Scripting on this page enhances content navigation, but does not change the content in any way.