webMethods API Portal Documentation
Document Conventions
Online Information and Support
Data Protection
API Portal Administrator's Guide
About this Guide
Overview
Why do Organizations Expose APIs?
Why do APIs Need to be Managed?
What is webMethods API Portal?
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 Workflows for User Registration
Assigning Users to the Approver Group
Configuring the Approval Workflow
User Registration Process
Defining a User Registration
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
Restoring the Default Configuration Settings Tenant-wide
Advanced Configuration of API Portal
Configuring API Portal with External Databases
Configure API Portal with Microsoft® SQL Server 2016 or Microsoft® SQL Server 2014
Configure API Portal with an Oracle Database
High Availability setup in API Portal
Setting up API Portal HA setup
Setting up API Portal HA setup with External Database (Oracle)
Managing Tenants
Creating tenants
Deleting Tenants
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)
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
Configuring Display Settings
Scheduling Reports for Application Usage
Managing Notifications
Forwarding a Page of the Online Help
Searching in API Portal
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
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 Providers
Manage API Providers
Creating an API Provider
Deleting an API Provider
Modifying Details of an API Provider
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 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
Using and Testing APIs
API Gallery
Finding APIs in the API Gallery
Viewing API Details
API Details View
Editing APIs
Modifying the Basic Attributes of an API
Modifying the Advanced Attributes of an API
Markdown Support
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
Managing API Packages and Plans
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
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 Communities
Communities
Communities View
Creating a Community
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 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 Collaboration
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
Analytics
Dashboard
Global Dashboard
API Audit Log
User Audit Log
Runtime Dashboard
API Trends Dashboard
Consumer Dashboard
Viewing Dashboards
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
API Portal Provider's Guide
About this Guide
General
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
Configuring Display Settings
Scheduling Reports for Application Usage
Generating a Secret Token
Generating an OTP Using the Secret Token
Forwarding a Page of the Online Help
Searching in API Portal
Managing API Providers
Manage API Providers
Creating an API Provider
Deleting an API Provider
Modifying Details of an API Provider
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
Using and Testing APIs
API Gallery
Finding APIs in the API Gallery
Viewing API Details
API Details View
Editing APIs
Modifying the Basic Attributes of an API
Modifying the Advanced Attributes of an API
Markdown Support
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
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 Collaboration
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
Analytics
Dashboard
API Trends Dashboard
Runtime Dashboard
API Audit Log
Consumer Dashboard
Viewing Dashboards
API Portal Consumer's Guide
About this Guide
General
Registering as a User for webMethods API Portal
Logging onto API Portal through the User Interface in a Browser
Logging onto API Portal Using a One-time Password
Logging onto API Portal Using the Social Account Credentials
Changing the Password
Editing your Profile
Configuring Display Settings
Scheduling Reports for Application Usage
Generating a Secret Token
Generating an OTP Using the Secret Token
Forwarding a Page of the Online Help
Searching in API Portal
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
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 Collaboration
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
Analytics
Dashboard
Consumer Dashboard
Viewing Dashboards
Legal
Copyright
webMethods API Portal Documentation
Copyright
to-landing_page
re-document_conventions
re-online_information
to-data_protection
co-oview_why_expose_apis
co-oview_what_is_api_management
co-oview_what_is_api_portal
co-config_security_overview
co-config_securing_client_requests
ta-config_options_method
ta-config_secure_password
co-config_sending_email_notifications
ta-config_configuring_smtp_mail_server_umc
ta-config_configuring_smtp_mail_server
co-config_ports_overview
ta-config_disabling_port
ta-config_enabling_port
co-config_testing_https_requests
co-config_considerations_multiple_nwinterfaces
ta-config_reconfiguring_load_balancer
co-config_reconfig_loadbalancer_dmzproxy
ta-config_reconfig_loadbalancer_dmzproxy
ta-config_adding_ssl_cert_to_loadbalancer
ta-config_update_sslcert
co-config_license_file
ta-config_license-file-ACC
ta-config_license-file-UMC
co-config_registering_users
ta-config_approval_workflow
ta-config_assign_users_approver_group
ta-config_your_approval_workflow
re-user_registration
APIP_user_registration
ta-customizing_user_registration
re-pending_approvals
APIP_Pending_Approvals
ta-displaying_pending_approvals_user_reg
ta-approving_user_registration
ta-rejecting_user_registration
co-config_view_manage_users
co-config_email_notif_templates_tokens
ta-config_customize_email_template
re-config_email_tokens
co-config_user_reg_social_network
ta-config_google_login
ta-config_facebook_login
re-config_oauth_properties_social_login
ta-config_removing_social_login
re-config_settings
APIP_Config_Settings
ta-configuring_tenantwide_settings
ta-restoring_default_settings_tenantwide
co-config_advanced_configuration_api_portal
co-config_configuration_api_portal_external_db
ta-config_apiportal_ms_sqlserver
ta-config_apiportal_oracle_db
co-ha_setup
ta-setting_up_HA_setup
ta-apmgt_ha_setup_oracle_database
co-config_manage_tenants
ta-config_create_tenants
ta-config_delete_tenants
co-apmgt_overview
co-apmgt_initialization_steps
ta-apmgt_starting_api_portal_windows
ta-apmgt_starting_api_portal_linux
ta-apmgt_stopping_api_portal_windows
ta-apmgt_stopping_api_portal_linux
re-apmgt_api_portal_server_components
re-apmgt_verifying_status_api_portal_components
re-apmgt_understanding_api_portal_component_status
re-apmgt_starting_stopping_api_port_components
ta-apmgt_opening_api_portal_ui
ta-schedule_reports_ca
ta-manage_notifications
APIP_Manage_Notifications
co-um_overview_managing_users
re-um_predefined_roles_api_portal
ta-import-ldap-users
ta-sync-ldap-user-umc
co-password_policy
ta-password_policy_configure
ta-configure_multiple_ldap_servers
ta-um_enable_mfa
ta-um_config_saml
co-assetmgt_planning_for_api_mgmt
co-assetmgt_about_api_portal_assets
co-assetmgt_api_portal_profile_in_centrasite
co-assetmgt_publishing_apis_to_api_portal
co-assetmgt_handling_requests_for_api_access_tokens
co-assetmgt_api_portal_extension_points
co-assetmgt_managing_keymgmt_providers
co-assetmgt_managing_access_tokens_912
co-api_packages_plans
ta-package_create
ta-package_create_plan
ta-package_link_plan
ta-package_unlink_plan
ta-package_delete
ta-package_link_api
ta-package_unlink_api
ta-package_link_provider
ta-package_unlink_provider
co-communities
re-communities_view
APIP_Communities_View
ta-creating_community
ta-defining_community_admins
ta-adding_members_to_community
ta-removing_members_from_community
ta-adding_usergroups_community
ta-removing_usergroups_community
ta-removing_user_from_admin_group
ta-leaving_community
ta-adding_apis_community
ta-removing_apis_community
re-dashboards
APIP_Dashboard
re-global_dashboard
APIP_Global_Dashboard
re-user_audit_log_dashboard
co-configuring_audit_log
co-purging_logs
ta-purging_logs_using_rest
ta-purging_from_ui
co-backup_restore_tenant_data
ta-config_using_acc_rest
ta-config_using_config_file
ta-config_backup_tenant_data
ta-backingup_tenant_data
ta-config_restore_tenant_data
ta-restoring_tenant_data
co-troubleshoot_backup_restore
ta-collect_logs
co-apiportal_ui_framework
APIP_Views
ta-creating_customized_view
ta-activating_view
ta-customizing_pages
ta-restoring_default_item_page
ta-backup_view
ta-restoring_view
ta-renaming_view
ta-deleting_view
co-remove_user_data
ta-schedule_reports_pv
co-api_provider_mgmt
APIP_Manage_API_Provider
ta-create_api_provider
ta-delete_api_provider
ta-edit_api_provider
re-manage_api
APIP_Manage_API
ta-importing_api_through_apiportal
ta-importing_api_upload_api
ta-importing_api_provide_url
ta-importing_api_pasting_apicontent
ta-deleting_api
ta-update_api
co-api_versions
ta-create_api_version
co-api_editing
ta-modify_api_name_desc
ta-modify_api_advanced_edit
co-markdown_support
re-dashboards_pv
APIP_Dashboard_pv
re-api_trends_dashboard
APIP_APItrends_Dashboard
re-api_runtime_events_dashboard
APIP_Runtime_Events_Dashboard
re-api_audit_log_dashboard
to-ag_about_this_guide
ta-register_apiportal
ta-opening_api_portal_ui_pv_ct
ta-apmgt_logon_email_otp
ta-logon_social_account_ct_pv
ta-change_password
ta-edit_own_profile
ta-config_display_settings
ta-schedule_reports_ct
ta-generate_secrettoken
ta-generate_otp_secrettoken
ta-forward_page_olh
co-global_search
re-api_gallery
APIP_API_Gallery
ta-finding_apis
ta-viewing_api_details
re-api_details
APIP_API_Details
ta-testing_rest_api
ta-testing_soap_api
ta-testing_odata_api
co-oauth_support
ta-testing_oauth_protected_api
ta-testing_jwt_protected_api
ta-following_api
ta-sharing_api
ta-download_client_sdk
re-manage_access_token
APIP_Manage_Access_Token
ta-view_application_details
re-application_details
APIP_Application_Details
ta-renewing_access_tokens
ta-revoking_access_tokens
co-packages_plans
ta-view_package_plan
re-api_package_details
APIP_API_Package
re-app_gallery
APIP_App_Gallery
re-app_details
APIP_App_Details
re-manage_app
APIP_Manage_App
ta-create_app
ta-delete_app
ta-edit_app
co-collaboration
re-collaboration_view
APIP_Collaboration_View
ta-creating_changing_user_profile
ta-find_usrs_grps_follow_feeds
ta-define_filters
ta-comment_flag_share_posts
ta-create_group
ta-invite_users_collaboration
ta-edit_req_join_grp_as_coordinator
ta-grant_grp_admin_privileges
ta-check_activities_collab_admin
ta-modifying_notification_settings
ta-commenting_on_portal_content
ta-publish_posts
ta-use_hashtags
ta-follow_apiportal_content_as_group
ta-find_help
re-dashboard_ct
APIP_Dashboard_ct
re-user_dashboard
APIP_Custom_Dashboard
ta-opening_dashboard
to-online-copyright-page