1/11
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
1
PRM Portals and API Management Platform Overview
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 the PRM API Development Process
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
Security and the API Management Framework
PRM Portal Service Level Agreements
Extending the PRM API Portals
2
PRM Portals and the Application Development Process
Required Software
Accessing the PRM Portals
Understanding the Partner Portal User
Accessing Partner and API Management Portal
Accessing Network Service Supplier Portal
Setting Up a Network Service Supplier Account
Accessing Partner Portal
Setting Up a New Partner Account
About the Application Development Process
About the Types of Interfaces Used in an API
About Registered Network Services
About Developing Applications
About the Communication Services Provided by Services Gatekeeper
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 the Status of an API
About Temporarily Suspending APIs
Providing API Credentials to Partners
Creating APIs for Use in Partner Applications
Configuring Actions Chains to Manage Traffic Involving an API
About Action Chains
Actions in the Server-Initiated Flows
Actions in the Application-Initiated Flows
Front and Middle Actions on a Request or Response
Actions Provided by Services Gatekeeper
Understanding the API Back-end Server Configuraton
Updating APIs
About an API Status and Modifications to its Data
About API Versions
Removing APIs
Monitoring API Usage
5
Managing Partner Applications
About Applications
Life Cycle of an Application
Application States and Notification Entries
Data Integrity During Updates to Applications
Managing Application Traffic EDRs
6
Managing Partner 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
7
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
8
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
Scripting on this page enhances content navigation, but does not change the content in any way.