Axway API Portal 7.5.5 Release Notes

Document version: 28 September 2018

Summary

API Portal provides an API consumer-facing interface that you can customize to match your corporate brand. API Portal is a layered product linked to API Manager, and requires both API Manager and API Gateway 7.5.3 or later. For more information, see the API Gateway and API Manager documentation.

API Portal is available as a virtual appliance (see Known issues), a software installation, or a virtualized deployment in Docker containers. For more details on appliance options, see the API Gateway Appliance Installation and Administration Guide.

New features and enhancements

The following new features and enhancements are available in this release.

Deploy API Portal to multiple datacenters

Distribute your environment across multiple datacenters to improve the availability, reliability, and performance.

  • Achieve high availability (HA) on datacenter level.
  • Distribute your API Portal to globally to span multiple datacenters, and provide a datacenter geographically close to your operations and your customers to diminish the latency in traffic.
  • Safeguard your operations against breaks in service – if one datacenter fails, the others continue to operate and process the requests.
  • Continuously replicate your data between the datacenters with the active-active model for constant consistency.

For more details, see API Portal Installation and Upgrade Guide.

Connect to multiple API Manager instances

Bring APIs from several API Managers to be explored centrally in one place.

  • Present APIs from different environments – like sandbox, testing and production – in one API Catalog.
  • Pull APIs to a single API Portal from different API Manager deployments, for example, from both on-premise and cloud.
  • No need to have separate API Portals for internal and external users simply because you have separate API Managers for them.
  • Access to APIs controlled by the organizations in API Managers, so no extra steps.

For more details, see API Portal Installation and Upgrade Guide.

Improve performance with Redis cache

You can configure API Portal to use a Redis cache to improve scalability of API Portal.

  • Better performance if your API Catalog has hundreds of APIs.
  • Better performance when connecting API Portal to multiple API Managers.

For more details, see API Portal Installation and Upgrade Guide.

Hide the Applications page in Public API

You can hide the Applications page from your API Portal when the Public API feature is enabled.

For more details, see API Portal Administrator Guide.

View application and API scopes in API Portal

You can view the scopes that API administrators have configured for applications or APIs in API Manager on the Applications page or in API Catalog.

For more details, see API Portal User Guide.

Improved usability in Joomla! Administrator interface

The API Portal settings have been regrouped so it is now easier to find the right section.

For more details, see API Portal Administrator Guide.

Improved security

The security of API Portal has been improved:

  • Joomla! version has been updated to v3.8.0 to fix security vulnerabilities.

Fixed issues

Internal ID Case ID Description
IAP-505 00901447 Issue: A PUT request does not send form parameters.
Resolution: Previously, when you used the Try It functionality in API Portal to test an API and sent a PUT request to API Manager, the sent request did not include the form parameters even if you provided them. Now, the PUT request includes also the from parameters.
IAP-572, IAP‑582 00915887 Issue: API Portal does not support a query parameter with an exclamation mark.
Resolution: Previously, when testing an API in API Portal, if your query or path parameter included an exclamation mark, the Try it method failed. Now, you can use query and path parameters including exclamation marks or other special characters to test an API.
IAP-589 00908285 Issue: API Portal does not show reCaptcha on API Portal sign-up page.
Resolution: Previously, when you configured reCaptcha for the API Portal sign-up, it did not appear on the sign-up page, because API Portal did not support reCaptcha 2.0. Now, API Portal supports also reCaptcha 2.0, and reCaptcha is properly displayed on the API Portalsign-up page.
IAP-593 00910982 Issue: Localized API Portal switches to English after signing out.
Resolution: Previously, if you had localized your API Portal user interface into another language than English, when a user signed out of the portal, the language changed back to English. Now, the localized API Portal remains localized even after a signing out.
IAP-641 00921503 Issue: Hidden tags visible in API Portal.
Resolution: Previously, if you tagged an API with a tag you had set to be hidden in API Catalog, the tag was hidden in the API Catalog, but still visible in the API details. Now, hidden tags are also hidden in the API details.
IAP-672 00924778 Issue: No instructions how to disable TLS 1.0 and 1.1.
Resolution: Previously, documentation did not specify how to disable TLS 1.0 and 1.1. API Portal does not use these versions, but they are enabled by default on API Portal software installation. Now, steps to disable the unnecessary TLS versions have been added to the documentation.

Known issues

The following are known issues in this version of API Portal.

No dedicated API Portal 7.5.5 appliance image

Starting from API Portal 7.5.4, a version-specific OVA image is no longer provided, but virtual appliance as a form factor is still supported. If you are a new customer, first install API Portal 7.5.3 OVA image, and then upgrade API Portal to v7.5.5.

For more details, see API Portal Installation and Upgrade Guide.

Issues viewing multiple versions of the same API in API Catalog

If you have exposed multiple versions of an API in API Manager, API Catalog did not show them correctly. This has been fixed in API Portal, but you must also install API Manager 7.5.3 Service Pack 4 to fully fix the issue. API Gateway and API Manager 7.5.3 SP 4is available from Axway Support at https://support.axway.com.

Email address as the login name

API Portal users whose login name is the same as their email address cannot change their email address.

Joomla! Update function not visible

In API Portal 7.5.5, you may not see the Joomla! Update included in the Components menu in JAI.

To get Joomla! Update show up in the menu, do the following:

  1. Look up s8f7h_menu table in your Joomla! database.
  2. Find the id of the row with the title com_joomlaupdate.
  3. Execute the following SQL query in the Joomla! database:
  4. > update s8f7h_menu set menutype='main' where id = <id>;

    Replace the placeholder with the id of com_joomlaupdate.

Documentation

You can find the latest information and up-to-date user guides at the Axway Documentation portal at http://docs.axway.com.

This section describes documentation enhancements and related documentation.

Documentation enhancements

See What's new in documentation for a summary of the documentation changes in this release.

API Portal is a layered product relying on both Axway API Manager and Axway API Gateway that provide the underlying gateway capabilities. API Gateway and API Manager are prerequisite products for API Portal.

API Gateway, API Manager, and API Portal are accompanied by a complete set of documentation, covering all aspects of using the products. Go to the Axway Documentation portal at http://docs.axway.com to find documentation for this product version. Additional documentation may be available at Axway Support at https://support.axway.com.

The AMPLIFY API Management solution enables you to create, publish, promote, and manage Application Programming Interfaces (APIs) in a secure and scalable environment. For more information, see the AMPLIFY API Management Getting Started Guide.

The following reference documents are available on the Axway Documentation portal at http://docs.axway.com:

  • Supported Platforms
  • Lists the different operating systems, databases, browsers, and thick client platforms supported by each Axway product.
  • Interoperability Matrix
  • Provides product version and interoperability information for Axway products.

Support services

The Axway Global Support team provides worldwide 24 x 7 support for customers with active support agreements.

Email support@axway.com or visit Axway Support at https://support.axway.com.

See Get help with API Gateway in the API Gateway Administrator Guide for the information that you should be prepared to provide when you contact Axway Support.

Related Links