1/12

Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents

1 Understanding API Management with the PRM Portals

• About the Services Gatekeeper API Management Platform
  • About the PRM Portals and Users
  • How the API Management Platform Works
    • About the Elements that Control the Quality of Service
• About Developing APIs
  • Configuring Network Service Interfaces to Expose Your Services
  • Configuring APIs to Expose Your Services For Use by Partner Applications
  • Subscribing to APIs to Enhance Partner Applications
  • How Services are Deployed Using PRM Portal Applications
• Using Report Statistics to Maintain Quality of Service
• Understanding API Management Security
  • Using Cross-Origin Security with APIs
• About PRM Portal Service Level Agreements
• About Extending the PRM API Portals

2 Developing Applications with the PRM Portals

• Required Software
• Accessing the PRM Portals
  • Understanding the Partner Portal User
  • Starting the Partner and API Management Portal
  • Starting the Network Service Supplier Portal
    • Setting Up a Network Service Supplier Account
  • Starting the Partner Portal
    • Setting Up a New Partner Account
• About Developing Applications
  • About the Types of Interfaces Used in an API
    • About Registered Network Services
  • About Developing Applications
  • About the Services Gatekeeper Communication Services
• Updating an Active Application
  • About Data Integrity During Updates to an Active Application
  • Ways in Which an Active Application is Updated

3 Managing Network Service Interfaces

• About Network Resources and Service Interfaces
• About the Network Service Interface Data
• About Interface Statuses
• Life Cycle Stages of a Network Service Interface

4 Managing APIs for Partner Applications

• About APIs for Partner Applications
  • About the API Data
  • About Naming Your APIs
  • About Presenting API Resources to Your Customers
    • Using Variables and Wildcard Characters in the Request Path and Service Path
  • About the Status of an API
    • About Temporarily Suspending APIs
  • About API Versioning
  • Providing API Credentials to Partners
• Creating APIs for Use in Partner Applications
• Manipulating HTTP Query Parameters in API Messages
• Securing Services Gatekeeper Methods and API Services
  • Securing the Services Gatekeeper API Methods
  • Securing the API Service
• Configuring Actions Chains to Manage API Traffic
• Understanding the API Back-end Server Configuration
• Updating APIs
  • About an API Status and Modifications to its Data
• Suspending Applications from Using an API
• Removing APIs
• Monitoring API Usage

5 Using Actions to Manage and Manipulate API Traffic

• Configuring Actions Chains to Manage API Traffic
  • About Action Chains
  • Actions in Application-Initiated Flows
  • Actions in Server-Initiated Flows
  • Understanding Front and Middle Actions
  • About Action Statuses
• Setting Actions System Administration Settings
  • Setting Actions System Performance Settings
    • Using the Administration Console to Set Action System Performance Settings
    • Using the Weblogic Startup Script to Set Action System Performance Settings
  • Setting Actions White and Black Lists
• Understanding the Default Actions
  • appKeyValidation
  • Callout
  • CORS
  • Groovy
    • Prohibited Components in Groovy Actions
  • Json2Xml
  • RateLimit
  • SchemaValidation
  • Throttling
  • Xml2Json
  • XSLT
• Common Actions Programming Tasks
  • Printing and Changing Message Content
  • Using Actions to Manipulate HTTP Query Parameters
    • Using a Groovy or Custom Action to Manipulate Query Parameters
    • Groovy Query Manipulation Code Examples
  • Using Actions to Translate Between REST and SOAP
    • REST to SOAP Translation
    • SOAP to REST Translation
• Understanding the Troubleshooting Action Information in EDRs

6 Managing Partner Applications

• About Applications
  • Life Cycle of an Application
  • Application States and Notification Entries
  • Data Integrity During Updates to Applications
• Collecting Information About Application Traffic with EDRs

7 Managing Partners and Partner Groups

• Overview of Accounts and Roles
• About the Registration Review
• Managing Accounts
  • Setting Up Accounts in Partner and API Management Portal
    • Creating Partner Accounts in Partner and API Management Portal
  • Managing Accounts
• Managing Partner Groups
  • Group Assignments for Partners and SLAs
  • Deleting Partner Groups

8 Managing Application and API Usage with Report Statistics

• Working with Reports
  • About Accessing the Reports
  • About the Reporting Process
  • Running a Report
  • Saving Your Reports
• About the Reports
  • API Usage and Trend Reports
    • Total API Usage
    • API Specific Usage
    • API Specific Usage Trend
    • API Method-Specific Usage Trend
  • API Response Time and Trend Reports
    • API Response Time
    • API Specific Response Time
    • API Specific Response Time Trend
    • API Method-Specific Response Time Trend
  • API Failure Rate Reports
    • API Failure Rate
    • API Specific Failure Rate
    • API Specific Failure Rate Trend
    • API Method-Specific Failure Rate Trend
  • Application Usage and Trend Reports
    • Application Total API Usage
    • Application API Specific Usage
    • Application API Specific Usage Trend
    • Application API Method-Specific Usage Trend
  • Application Response Time and Trend Reports
    • Application API Response Time
    • Application API Specific Response Time
    • Application API Specific Response Time Trend
    • Application API Method-Specific Response Time Trend
  • Application Failure Rate Reports
    • Application API Failure Rate
    • Application API Specific Failure Rate
    • Application API Specific Failure Rate Trend
    • Application API Method-Specific Failure Rate Trend
  • API Application Adoption
    • Total API Application Adoption
    • API Method Application Adoption
  • API Parameter-Based Reports
    • Parameter Existence
    • Parameter Value
  • Subscriber Application Usage Reports
    • Subscriber Usage Report
    • Application Subscriber Trend Report
    • Region Subscriber Report

9 Administering the PRM Portals

• Resetting Passwords
  • Requesting for a Network Service Supplier or Partner Password to be Reset
  • Resetting Passwords in Partner and API Management Portal
  • Resetting Passwords in Network Service Supplier or Partner Portal
• About Customizing PRM Portals