About this Help
Document Conventions
Online Information and Support
Data Protection
What is webMethods API Portal?
webMethods API Portal for Administrators
Managing API Portal
Overview of Managing API Portal
What Happens When You Start API Portal?
Starting API Portal (Windows)
Starting API Portal (Linux/UNIX)
Stopping API Portal (Windows)
Stopping API Portal (Linux/UNIX)
Changing Clous Password
API Portal Components
Verifying the Status of API Portal Components
Understanding API Portal Component Status in ACC
Starting and Stopping API Portal Components
Opening the API Portal User Interface in a Browser
Changing the Password
Editing your Profile
Managing Teams
Creating Teams
Editing Teams
Deleting Teams
Notifications
Forwarding a Page of the Online Help
Configuring API Portal
Security Considerations
Securing Client Requests
Preventing Use of the HTTP OPTIONS Method
Implementing Secure Password Policies
Sending Email Notifications
Configuring the SMTP Mail Server Connection for API Portal using the User Management Component
Configuring the SMTP Mail Server Connection for API Portal using ACC
Configuring Ports
Disabling a Port
Enabling a Port
Testing for HTTPS Requests
Considerations for Machines with Multiple Network Interfaces
Reconfiguring the Load Balancer when you configure multiple API Portal machines
Reconfiguring the Loadbalancer in case of a DMZ or Reverse Proxy Setup
Reconfiguring the Loadbalancer Settings
Adding a SSL Certificate to Load Balancer
Updating the SSL Certificate
API Portal License File
Importing the API Portal License File using the ACC
Importing the API Portal License File using the UMC
Configuring User Registration
Configuring Approval Workflow for User Registration
Assigning Users to the Approver Group
Configuring the Multi-Level Approval Workflow
User Registration Process
Pending Approvals
Displaying Pending Approvals for User Registration Requests
Approving a User Registration Request
Rejecting a User Registration Request
View and Manage Users
Email Notifications Templates and Tokens
Customizing Email Templates
Email Tokens
User Registration in API Portal with Social Login
Configuring Google Login
Configuring Facebook Login
OAuth Properties for Social Login
Removing Social Login
Configuration Settings
Customizing Tenant-wide Configuration
Resetting the Default Configuration Settings Tenant-wide
Advanced Configuration of API Portal
Accessing Elasticsearch
Accessing Elasticsearch Using Auto-generated Access Details
Configuring Elasticsearch Access Details
Disabling Secure Access of Elasticsearch
Configuring API Portal with External Databases
Configure API Portal with Microsoft® SQL Server
Configure API Portal with an Oracle Database
Taking a Back up of API Portal database
Starting Zookeeper Service
Registering External Oracle DBMS
Creating Database Schema for Tenants
Enhancing Runnables with JDBC Driver for External Database
Registering the External Service Database
Assigning Tenant to the Database Service
Restoring the backed up data
Configuring API Portal with a Postgres Database
Backing up API Portal Database
Starting Zookeeper Service
Creating Postgres Database and User
Registering the External Service Database
Starting all Runnables
Restoring the backed up data
High Availability setup in API Portal
Setting up API Portal HA setup
Adding of Nodes
Deconfiguring Runnables and Reconfiguring Zookeeper
Reconfiguring Elasticsearch
Reconfiguring Other Runnables
Starting the High Availability Setup
Setting up API Portal HA setup with External Database (Oracle)
Adding of Nodes
Deconfiguring Runnables and Reconfiguring Zookeeper
Reconfiguring Elasticsearch
Reconfiguring Other Runnables
Registering External Oracle DBMS
Creating Database Schema for Tenants
Enhancing Runnables with JDBC Driver for External Database
Registering the External Service Database
Assigning Tenant to the Database Service
Starting the High Availability Setup
Managing Tenants
Creating Tenants
Deleting Tenants
Securing Internal Network Resources
Enabling Internal Network Security
Configuring the API Endpoint Validation
Configuring Sub-domain Names for API Portal Tenants
Configuring Domain Address
Managing Users
Overview of Managing Users
User Roles and Groups in API Portal
Importing LDAP Users and User Groups into User Management Console
Synchronizing LDAP Users or User Groups with User Management Console
Assigning Privileges to User Groups
Password Policy for API Portal Users
Configuring password policy for API Portal Users
Configuring LDAP Servers
Enabling Multi-factor Authentication
Configuring SAML 2.0 for a Consumer User
Managing API Assets
Planning for API Management
About API Portal Assets
API Portal Profile in CentraSite
Publishing and Unpublishing APIs to and from API Portal
Handling Events
API Portal Extension Points
Managing Third-party Key Management Providers
Managing Access Tokens
Managing API Packages and Plans
Creating an API Package
Creating a Plan
Associating a Plan to a Package
Disassociating a Plan from an API Package
Deleting an API Package
Associating APIs with a Package
Disassociating APIs from an API Package
Associating Providers with a Package
Disassociating Providers from an API Package
Managing Communities
Communities
Communities View
Creating a Community
Editing Community Details
Defining Community Administrator
Adding Members to a Community
Removing Members from a Community
Adding User Groups to a Community
Removing User Groups from a Community
Removing a User from the Community Administrator Group
Leaving a Community
Adding APIs to a Community
Removing APIs from a Community
Managing Data in API Portal
Configuring Audit Logs
Purging Logs
Purging logs by invoking a REST service
Purging logs through the user interface
Backing up and Restoring Tenant-specific Data
Registering Nodes Using the ACC REST Service
Registering Nodes Using the Configuration File
Backing up Tenant-specific Data
Backing up Tenant-specific Data Through the User Interface
Restoring Tenant-specific Data
Restoring Tenant-specific Data Through the User Interface
Troubleshooting Backup and Restore Failures
Collecting API Portal Logs
Customizing API Portal Views
API Portal Views
Creating a View
Activating a View
Customizing Pages
Restoring a Default Item or Page
Backing up a View
Restoring a View
Renaming a View
Deleting a View
Remove User Data from API Portal
Removing User Data
Anonymizing user data in UMC
Anonymizing user data in ECP
webMethods API Portal for Providers and Consumers
Logging On to API Portal as Administrator or Consumer
Logging onto API Portal through the User Interface in a Browser
Logging onto API Portal Using a One-time Password
Changing the Password
Editing your Profile
Generating a Secret Token
Generating an OTP Using the Secret Token
Forwarding a Page of the Online Help
Searching in API Portal
Register in webMethods API Portal as a Consumer
Registering and Logging On as a Consumer using Social Account Credentials
Registering as a User for webMethods API Portal
Logging onto API Portal using Social Account Credentials
webMethods API Portal for All Users
Managing API Portal
Configuring Display Settings
Scheduling Reports for Application Usage
Configuring Display Settings
Using and Testing APIs
API Gallery
Finding APIs in the API Gallery
Viewing API Details
API Details View
Testing a REST API
Testing a SOAP API
Testing an OData API
OAuth 2.0 Support
Testing an OAuth Protected API
Testing a JWT protected API
Following an API
Sharing an API
Downloading Client SDK for an API
Managing Applications
Applications
Viewing List of Applications and Application Details
Application Details View
Renewing Access Tokens
Revoking Access Tokens
Application Sharing
Sharing an Application
Revoking Access from a Shared Application
Scheduling Reports for Application Usage
Managing API Packages and Plans
API Packages and Plans
Viewing API Packages and Associated Plans
API Package details
Managing Apps
App Gallery
App Details View
Manage Apps
Creating an App
Deleting an App
Modifying Details of an App
Managing Collaboration
Collaboration
Collaboration View
Modifying a User Profile
Finding Users and Groups and Following their Feeds
Defining Filters
Commenting on, Sharing, and Flagging Posts
Creating a Group
Inviting other Users to Collaborate
Accepting or Denying Requests to join Private Groups
Granting or Revoking Group Coordinator Privileges
Checking Activities Reported as Inappropriate
Modifying Notification Settings
Commenting on Portal Content
Publishing Posts
Using Hashtags
Following API Portal content as a Group
Finding Help
Manage API Providers as Administrators or Providers
Managing API Providers
Manage API Providers
Creating an API Provider
Deleting an API Provider
Modifying Details of an API Provider
Manage APIs as Administrators or Providers
Managing APIs
Manage APIs
Importing an API Directly through the API Portal User Interface
Importing an API by Uploading an API
Importing an API by Providing an API URL
Importing an API by Copying and Pasting API Content
Deleting an API
Updating an API
API Versions
Creating a New API Version
Editing APIs
Modifying the Basic Attributes of an API
Modifying the Advanced Attributes of an API
Markdown Support
API Analytics for Administrators and Providers
Analytics
Dashboard
Global Dashboard
API Audit Log
Runtime Dashboard
API Trends Dashboard
Consumer Dashboard
Viewing Dashboards
Copyright
About this Help
Copyright
APIP_Manage_Notifications
APIP_user_registration
APIP_Pending_Approvals
APIP_Config_Settings
APIP_Communities_View
APIP_Views
APIP_API_Gallery
APIP_API_Details
APIP_Manage_Access_Token
APIP_Application_Details
APIP_API_Package
APIP_App_Gallery
APIP_App_Details
APIP_Manage_App
APIP_Collaboration_View
APIP_Manage_API_Provider
APIP_Manage_API
APIP_Dashboard
APIP_Global_Dashboard
APIP_Runtime_Events_Dashboard
APIP_APItrends_Dashboard
APIP_Custom_Dashboard