Portal Administration

Copyright © TIBCO Software Inc. All Rights Reserved

Chapter 1 Administration : Portal Administration

Portal Administration

Portal administrators have full access to all product features and all functions on the portal. Their primary role is to create environments and add gateways to the environments, manage users and user roles, and manage APIs, products, subscriptions and scopes. Portal administrators can also view API usage data on the analytics dashboard.

The Developer Portal is available if Adapter Code for TIBCO API Exchange and Joomla! 2.1.1 is installed in your environment. The portal administrator can use the portal to perform management tasks. Refer to the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1 documentation for detailed instructions.

Managing User Roles

The portal administrator is responsible for creating organizations, manager roles, and for managing users and subscriptions. Portal administrators are also responsible for creating and managing products, APIs, and product plans.

If you have installed Adapter Code for TIBCO API Exchange and Joomla! 2.1.1 in your environment, the portal administrator can create the users and user roles in the Joomla! Administrator back-end.

Managing Environments and Gateways

An environment defines an area in which products and applications can function; for example, “test,” “development,” and so on. Physically, an environment maps to a TIBCO API Exchange Gateway cluster. The environment defines a base path, which typically represents a load balancer in the network, and includes a protocol, host, port number, and a path. For example, http://localhost:8080/base_path_to_api. APIs that are deployed in this environment can be accessed by applications using this base path.

The portal administrator creates an environment and specifies information such as the type of environment and base path URL, and then adds one or more gateways to the environment. The portal administrator can also view and update the configuration for the gateway clusters contained in the environment.

If you have installed Adapter Code for TIBCO API Exchange and Joomla! 2.1.1 in your environment, the portal administrator can access the TIBCO API Exchange Gateway Config UI from the Developer Portal.

Master Configuration

Master configuration (also referred to as master copy) is the complete set of configuration provisioned by the portal engine to the gateway cluster for a subscription. If the local configuration of one or more gateway instances is out-of-sync, they can be fully re-provisioned with the master configuration.

The master configuration for a gateway cluster is composed of two parts: base and access.

•

Base configuration is set by the portal administrator (API provider) and does not change when application developers push updates from the portal. Base configuration is not environment specific.

•

Access configuration is updated when API subscriptions are created, and used by partners and applications. It contains information controlling the access to an API by certain organizations, users, and applications, which are environment-specific entities.

To use the master configuration for the first time, copy the entire set of the cluster configuration to ASG_CONFIG_HOME/environments/<env_name>/<gateway_name>/<project_name>. After that, any change to the base configuration must be made on both master configuration and the gateway instances' local configuration.

When moving the gateway configuration from a development environment to a production environment, you must move the base configuration manually. Do not move the access configuration in the development environment, because it might differ from the configuration in the production environment.

Use the tool, asg-tools, provided by API Exchange Gateway to export or import the base configuration from the development environment and then import it into the production environment. Access configurations in each environment remain unaffected. See TIBCO API Exchange Gateway Release Notes for details on using the tool asg-tools.

By default, the master copy is not maintained on the portal-engine. This is not recommended for a development environment.

For a production environment, you can choose to maintain the master copy in the portal engine by enabling master configuration from the gateway configuration UI > Portal Engine Properties.

If you are using the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1, you can access the gateway configuration UI can be accessed from the Developer Portal page that manages environments and gateways. You can use the gateway configuration UI in the portal to publish the master configuration to each gateway instance.

Managing Subscriptions

Portal administrators can create a subscription on behalf of an organization. For a given product and plan, the portal administrator specifies the start date and end date, and sets the status for the subscription.

An organization must have a valid subscription to a product before an application can use it. If needed, an application developer or manager must request a subscription to a product’s plan. Depending on the subscription type specified for the plan, the portal administrator might need to approve the request.

Subscription Request for a Plan with Auto-provisioning

When an application developer or manager places a request for a plan with auto-subscription enabled, the plan is automatically approved and a subscription for the organization that the requestor belongs to is created. By default, the validity for the subscription is set to five years.

If you are using the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1, the portal administrator can modify the start date and end date for the plan from Joomla. See the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1 documentation for details.

Approve Subscription Request for a Plan Without Auto-provisioning

When an application developer or manager places a request for a plan without auto-subscription enabled, an email notification is sent to the portal administrator and the requestor.

If you are using the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1, the portal administrator can choose to nominate one or more members as portal administrators by adding them to the SuperUsers group in the Joomla Admin utility. In this case, the email notification is sent to all the portal administrators. See the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1 documentation for details.

Approve Subscription Request for a Custom Plan

If an application developer or manager places a request for a custom plan, an email notification is sent to the portal administrator and requestor. The portal administrator needs to create the custom plan and provision it for the requestor.

If you are using the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1, refer to the Adapter Code for TIBCO API Exchange and Joomla! 2.1.1 documentation for details.

Managing OAuth 2.0 Scopes

TIBCO API Exchange supports OAuth 2.0 for authentication and authorization. See the TIBCO API Exchange Gateway documentation for details on setting up the OAuth infrastructure.

The portal administrator can define a scope by specifying the name and description for the scope. If scopes are enabled for the Developer Portal, the application developers can add one or more scopes to their applications, if they choose to use OAuth.