Axway API Portal 7.5.3 Release Notes

Document version: 17 September 2018

Summary

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

API Portal is available as a virtual appliance, 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.

Improved visual experience

User interfaces have been refreshed to a more visually attractive look shared by all Axway products.

  • All web-based user interfaces have been made cleaner and simpler.
  • Minor improvements to Policy Studio screens.
  • Shared look-and-feel makes the products feel familiar, making them easy to learn.

Easier upgrade

The API Portal upgrade process has been simplified.

  • One upgrade flow for virtual appliance and one for software installations regardless of the version numbers.
  • The upgrade script apiportal_upgrade.sh automatically upgrades components on virtual appliance installation, reducing the amount of manual configuration.

Docker container support

API Portal now supports Docker containers:

  • Containerized API Portal deployment to any OS or cloud platform supporting Docker (for example, IBM Bluemix).
  • End-to-end Docker support for API Management means that you can now run the full API Management solution in Docker containers.
  • Docker files are provided to enable you to create Docker containers for API Portal and MySQL.
  • CentOS Linux 7 base image to automatically create a multi-container environment.

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

Axway single sign-on support

API Portal now supports Axway single sign-on (SSO).

  • Greatly improves the overall user experience in API Portal.
  • Users can use the same login across Axway platform products.
  • Eliminates the need to log in multiple times to different web UIs, and enables integrating API Portal to other portals.
  • Integrates external SAML-based identity providers (IdP) to leverage unified user credentials.
  • Strengthens security because authentication can be delegated to an IdP supporting two-factor authentication.

For more details, see API Portal Administrator Guide.

Client SDK generator

API Portal client SDK generator leverages API Manager APIs to generate a downloadable SDK.

  • API consumers can create client SDKs of APIs exposed in API Catalog as they need them.
  • A client SDK abstracts API calls into objects that match the definition of API methods and schemas, and that handles the security aspects as well.
  • Simple interface makes the task quick and easy.
  • Multiple supported platforms, such as Titanium, Android, iOS and NodeJS.

For more details, see API Portal Administrator Guide and API Portal User Guide.

Improved security

Support for securing the connection from API Portal to MySQL using TLS has been added.

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

Localization support

Support for localizing your API Portal has been added.

  • UI texts, such as menu items and field names, can be translated from English to another language.
  • The sign-in URL can be language-specific.
  • Joomla! Admin Interface (JAI) and API Portal can use different languages.

For more details, see API Portal Administrator Guide.

Improved API Catalog

You can switch between two different views in API Catalog, and search APIs in using the API name, description, type, version, or tag.

For more details, see API Portal User Guide.

Platform support

  • CentOS 7

Fixed issues

Fixed security vulnerabilities

Internal ID Case ID CVE Identifier Description

RDAPI-7794

00882498

CVE‑2011‑4969

Issue: Cross-site scripting (XSS) vulnerability in API Portal.
Resolution: Previously, API Portal included a version of jquery-migrate (v1.2.1) that had a major XSS vulnerability. Now, jquery-migrate has been updated to a version that fixes this vulnerability.

Other fixed issues

Internal ID Case ID Description

RDAPI-1910

00818227

Issue: Missing security headers.
Resolution: Previously, API Portal did not add additional security headers to the responses. Now, the X-Frame-Options, X-XSS-Protection, Strict-Transport-Security, and X-Content-Type-Options headers are added.

RDAPI-6086

00856671

Issue: API Portal does not encode special characters in WSDL URLs.
Resolution: Previously, if you downloaded WSDL files using API Portal, characters requiring special XML encoding (such as the ampersand (&) symbol) to concatenate URL parameters, were not properly encoded. Now, characters requiring special XML encoding are properly encoded.

RDAPI-6510

00866948

Issue: Issue in API Portal displaying the response class.
Resolution: Previously, if the response class was an array of null, array[null] was displayed. Now, only array is displayed.

Known issues

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

Right-to-left languages

The API Portal UI has been designed for left-to-right languages. If you switch the language of API Portal to a right-to-left (RTL) language, such as Arabic or Hebrew, the portal layout is also switched to RTL and some UI elements may not show or align properly. The workaround for this is to log in to JAI, click Extensions > Templates > Purity III > General, and switch Development Mode to ON.

Email address as the login name

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

Client SDK generator

The Client SDK generator has the following known limitations:

  • The API name can only contain alphanumeric characters (no spaces).
  • Parameter names in the Swagger definition may only contain legal identifier characters (for example, no"." or "-").
  • Parameters with inline schemas need to have globally-unique names.
  • Swift generation support requires using Xcode 8.2 or earlier when compiling your project. Support for Swift 3 is to be included in a later update.
  • The generated Android SDKs contain broken code, because the template that is used has hardcoded strings. The workaround is to manually edit the files that do not compile to fix them.
  • The generated classes in the Android SDKs have short package names that consists only of the lower case API name.

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 API Management Plus solution enables you to create, publish, promote, and manage Application Programming Interfaces (APIs) in a secure and scalable environment. For more information, see the API Management Plus 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