Axway API Portal Release Notes DRAFT

Transcription

1 Axway API Portal Release Notes DRAFT Document version: 13 October 2017 New features and enhancements on page 1 Fixed issues on page 3 Known issues on page 3 Documentation on page 4 Support services on page 5 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 documentation. 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. Public API Expose non-business critical APIs to your developer community without login to lower the adoption barrier. Developers can explore your APIs and their methods without having to create the account from the start. Business critical information remains secured and is not accessible except to the authorized people. For more details, see API Portal Administrator Guide and API Portal User Guide. API Catalog customization You can now customize your API Catalog 1

2 Define and change the default view. Change page title and the summary text. Use tags to group APIs in to subsets and create, for example, themed API Catalogs. Enable or disable the Try it functionality or downloading Swagger definitions. For more details, see API Portal Administrator Guide. Flexible Joomla! configuration You can now specify the Joomla! database name and port when installing a new API Portal software installation or upgrading an existing installation. For more details, see API Portal Installation and Upgrade Guide. Improved security The security of API Portal has been improved: Joomla! version has been updated to v3.7.3 to fix security vulnerabilities You can specify the location where API Portal log files are stored. The number of login attempts to the Joomla! Administrator Interface (JAI) can now be limited to prevent brute force attacks. For more details, see API Portal Installation and Upgrade Guide. Platform support Starting from API Portal 7.5.4, a version-specific OVA image is no longer provided, but virtual appliance as a form factor is supported. If you are a new customer, first install API Portal OVA image, and then upgrade API Portal to v For more details, see API Portal Installation and Upgrade Guide. 2

3 Fixed issues Internal ID Case ID Description RDAPI Issue: Unable to change the Joomla! database name. Resolution: Previously, when you installed API Portal as a software installation, the Joomla! database name was hardcoded to joomla and you could not change the name. Now, you are prompted to provide an existing database name during the installation. This means that you must create your database before you start installing API Portal. RDAPI Issue: API Gateway license when running Docker images. Resolution: Previously, the documentation did not mention that you cannot use an API Gateway license tied to a hostname. Now, the documentation clearly states that you must use a license that is not tied to a hostname. Known issues The following are known issues in this version of API Portal. Post-installation cleanup on EasyBlog sometimes freezes If you install API Portal as a software installation and your PHP version is earlier than v5.6, when installing the EasyBlog plugin, the Post Installation Cleanup may freeze at 45% and fail. The workaround is to wait until the process times out and the Next step button changes to Retry again, and then try again. If the Next step button does not change within a few minutes, do the following: 1. Run the following SQL command: TRUNCATE TABLE s8f7h_easyblog_acl_groups; 2. Go to your API Portal directory, and run the following to reinstall EasyBlog: rpm -Uvh apiportal-easyblog x86_64.rpm 3. Repeat fixing the Joomla! database structure for EasyBlog. 3

4 address as the login name API Portal users whose login name is the same as their address cannot change their address. Joomla! Update function not visible In API Portal 7.5.4, 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: > 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 This section describes documentation enhancements and related documentation. Documentation enhancements See What's new in documentation on page 6 for a summary of the documentation changes in this release. Related documentation 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 to find documentation for this product version. Additional documentation may be available at Axway Support at 4

5 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 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. support@axway.com or visit Axway Support at 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. Copyright 2017 Axway. All rights reserved 5

6 What's new in documentation This topic describes the documentation changes in this release. API Portal API Portal Installation and Upgrade Guide Added the instructions on how to configure Joomla! database name and ports when installing a new API Portal software installation or upgrading an existing installation. Clarified the upgrade instructions. Added instructions onhow to limit the number of login attempts to Joomla! Administrator Interface (JAI). Added how to change where API Portal log files are stored. Added a note on the API Gateway license with Docker images. API Portal Administrator Guide Added a new section on how the Public API feature enables exposing non-business critical content without requiring a login. Added a new section on how to customize API Catalog view and functionalities. API Portal User Guide Added how to explore some sections of API Portal without signing in when Public API is enabled. Axway API Portal Release Notes 6