webMethods Developer Portal Documentation
About this Documentation
Document Conventions
Online Information and Support
Data Protection
Getting Started with Developer Portal
Let's get you started
Developer Portal Overview
Quick Start Milestones
How Do I Install Developer Portal?
How Do I launch and log on to Developer Portal?
Next steps...
Using Developer Portal
Overview
Why do Organizations Expose APIs?
Why do APIs Need to be Managed?
What is webMethods Developer Portal?
Administration
Overview
How do I configure SMTP settings to send emails?
How do I configure password policy?
Security Settings
How do I configure user account lockout settings?
How do I configure multi-factor authentication settings?
How do I configure advanced security settings?
How do I configure user session settings?
How do I configure email notification templates?
How do I configure webhooks to notify events to an external system?
List of events
How do I configure webhooks to notify user sign up and application requests to an external approval system?
How do I specify the Developer Portal URL for reference from external systems?
How do I update the Developer Portal license?
How do I configure the default group and community for a new user?
User management
Overview
Native Registration
How do I add a user?
How do I add a user group?
How do I assign privileges to a user?
Onboarding Strategy
How do I configure onboarding strategy to process user sign up requests?
How do I configure an approval workflow to process an internal approval onboarding strategy?
LDAP Users and Groups Onboarding
How do I create an LDAP connection to import users from a LDAP server?
How do I create an LDAP connection to import users from a secured LDAP server?
How do I specify attributes for the LDAP connection established with an LDAP server?
How do I import users and user groups from an LDAP server?
Single Sign-On Users Onboarding
SAML SSO Onboarding
How do I onboard users using their SAML service provider credentials?
How do I configure SAML settings to specify user onboarding configurations?
User Onboarding using Social Media Account
How do I onboard users using their Social media credentials?
Customization
Overview
Managing Themes
How do I create a theme for customizing the Developer Portal UI?
Customize pages
How do I customize a block on a page?
Customization fields
How do I add a new block and component?
How do I move blocks in a page?
How do I remove a block from a page?
How do I add a page?
Customize UI Components
How do I add a new item to the top navigation bar?
How do I customize the top navigation bar?
How do I customize the Sign up page?
How do I customize the API grid displayed in API gallery?
How do I customize the package grid?
How do I customize the API details pane?
How do I customize the plans grid?
Customize Labels
How do I add new UI labels?
Customize Color Schemes
How do I customize the color scheme used in a screen?
How do I customize the text and icon displayed in browser header?
Customization using Web components
How do I register a web component?
Sample Web component files
Customization example
Providers
Overview
How do I create a provider?
How do I map an API or a callback URL to a provider?
Communities
Overview
How do I create a community?
How do I map the required user, group, or API to a community?
APIs
Overview
How do I create an API?
How do I edit the basic attributes of an API?
How do I edit the advanced attributes of an API?
How do I create a new version of an API?
Trying APIs
Trying a REST API
Trying a SOAP API
Trying a OData API
Authorization fields
Troubleshooting Tips: Testing APIs published from API Gateway
Applications
Overview
How do I configure onboarding strategy to process application or subscription requests?
Creating an application
How do I create an application from Manage applications screen?
How do I create an application from API details screen?
How do I create an application from Try API screen?
Backup and restore
Overview
How do I take a backup?
How do I restore data from a backup file?
Developer Portal REST APIs
Overview
Viewing analytics
Managing APIs
Managing applications
Managing approvals
Managing backup and restore
Managing comments
Managing communities
Managing configurations
Viewing Developer Portal audit events
Viewing Developer Portal health
Managing notifications
Getting OAuth token
Managing packages
Managing plans
Managing providers
Performing search
Managing teams
Managing topics
Managing application and subscription requests
Managing users
Managing webhooks
Configuring High Availability
Overview
Configuring High Availability
Configuring API Data Store
Configuring Ignite
Configuring Developer Portal
Configuring Load Balancer
HTTPS Port Configuration
Configuring HTTPS Port
Configuring an HTTPS Port
Copyright
webMethods Developer Portal Documentation
Copyright