Customize API Portal look and feel

This section provides the basic information you need to get started with customizing your branded API Portal, including:

For internally-facing API deployments, you can deploy API Portal "as is" using the out-of-the-box Axway branding. This type of deployment requires no customization.

For external-facing API deployments, you may want to customize API Portal to provide a branded developer portal experience. This type of deployment contains a collection of style settings that can be configured in your account, including logos, colors, fonts or you can perform advanced modification of the layout and structure.

Supported API Portal customization

Customization can be performed at three levels:

  • Customization through configuration: Use the Joomla! Admin Interface (JAI) (https://<API Portal host>/administrator) to change CSS stylesheets, templates, and layouts. These types of customizations are can be upgraded and retained when you move to new version. The customization does not modify the API Portal source code and is supported by Axway.
  • Customization through code: API Portal is developed using the PHP scripting language and the source code is provided. This is how Joomla! applications are deployed. You can modify the PHP source code to customize API Portal, such as to change the functionality of pages and to extend by adding new pages.
  • Caution    
    • The customizations are lost when you upgrade. The source code is subject to frequent changes without notice; therefore, you must reintegrate customizations into the new API Portal code to avoid restoring a deprecated code along with the customizations.
    • If you submit a case to Axway Support and it is suspected that the customizations may be the root cause of the issue, you must reproduce the issue on a non-customized API Portal.
    • This type of customization is only recommended for customers with Joomla!/PHP experience that need to deploy a highly tailored developer portal.
  • Customization through the addition of Joomla! plug-ins: The Joomla! CMS offers thousands of extensions that are available from their website. Axway is only responsible for the support to extensions that are delivered out of the box (EasyBlog and EasyDiscuss).
  • Caution   If you submit a case to Axway Support and it is suspected that unsupported third-party extensions may be the root cause of the issue, you must reproduce the issue on a non-customized API Portal.

Prerequisites

To get started with customization, you need the following:

  • API Portal installed and configured. For more details, see the API Portal Installation and Upgrade Guide.
  • An API Portal user account. When you log in, the default API Portal web page is displayed, so you can check how the changes look to your end users.
  • Basic understanding of Joomla! ThemeMagic. This feature enables to change CSS stylesheets, templates, and layouts. For more advanced modifications, you can modify the PHP source code to customize API Portal, such as to change the functionality of pages and to extend by adding new pages.

Related Links