SOA Governance and API Management : Administering API Portal : Configuring API-Portal : Configuring CentraSite, Mediator, and API-Portal
Configuring CentraSite, Mediator, and API-Portal
 
API-Portal Configuration Parameters
To add and manage API-Portal instances in CentraSite, you must have the privileges of a CentraSite Administrator role or at least the API-Portal Administrator role.
*If you have the privileges of a CentraSite Administrator role, you can manage any API-Portal within any organization.
*If you have the privileges of an API-Portal Administrator role for an organization, you can manage all the API-Portal instances in that particular organization.
The API-Portal administrator is responsible for installing, configuring, and maintaining API-Portal. The administrator is also responsible for ensuring the server is secure, available to clients, and running at peak performance. Usually, one person is appointed as the API-Portal administrator, although most sites identify at least one other person to act as a backup.
For more information about roles, see Overview of Managing Users and the CentraSite Administrator’s Guide.
After the components listed in Before You Configure API-Portal are installed, additional configuration tasks must be performed to set up the environment in preparation for publishing APIs to API-Portal. The following table lists these high-level configuration steps and where to go for more information:
Step
Where to find the procedures
Import the API-Portal license file.
Configure the CentraSite infrastructure, including LDAP, email server, and log purging.
CentraSite Administrator’s Guide
Set up an organization structure for API provider and consumer organizations.
Working with the CentraSite Business UI
(Optional) Configure Mediator in a clustered Integration Server environment.
Section on configuring communication with CentraSite in Administering webMethods Mediator
Configure the communication link between Mediator and Enterprise Gateway.
Section on configuring Enterprise Gateway in webMethods Integration Server Administrator’s Guide
Configure the communication link between CentraSite and Mediator by defining Mediator targets in CentraSite.
CentraSite Administrator’s Guide
Create a technical user in CentraSite.
Specify this user when registering an API-Portal instance in CentraSite. It is considered a best practice not to tie critical actions (such as publishing data or APIs) to a real user whose credentials can expire.
Note:  
Software AG recommends specifying the same user credentials as the technical user created in Mediator and API-Portal.
Working with the CentraSite Business UI
Create a technical user for Mediator and add the user to the Administration group so that it may be used by CentraSite when publishing APIs to Mediator.
Note:  
Software AG recommends specifying the same user credentials as the technical user created in CentraSite and API-Portal.
Section on adding user accounts and adding users to a group in webMethods Integration Server Administrator’s Guide
Create a technical user in API-Portal and assign the user to the API Provider role.
Specify this user when registering an API-Portal instance in CentraSite. It is considered a best practice not to tie critical actions (such as publishing data or APIs) to a real user whose credentials can expire.
Note:  
Software AG recommends specifying the same user credentials as the technical user created in CentraSite and Mediator.
webMethods API-Portal Online Help
Create API Provider users (developers who can publish APIs to API-Portal) and assign the users to the API-Portal Administrator role.
Sections on adding a user, assigning a user to a group, and assigning a role to a user in CentraSite Administrator’s Guide
Register API-Portal instances with CentraSite.
Working with the CentraSite Business UI
Configure settings for proxy server, analytics, and geolocation.
Set up and customize email templates to be used when informing users about access token request, renewal, and expiration.
Section on managing API keys and OAuth 2.0 tokens in Working with the CentraSite Business UI
Create taxonomies in CentraSite that you can use to categorize APIs in the API-Portal Gallery page.
CentraSite Administrator’s Guide
Customize the API-Portal user registration and the e-mail-templates for user registration.
Define the advanced customizations of API-Portal.
Customize the user registration with social media for API-Portal.
Customize the API-Portal branding and set up API-Portal templates.
webMethods API-Portal Online Help
Copyright © 2015- 2016 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback