This documentation is for WSO2 API Manager 1.7.0 View documentation for the latest release.
Customizing the API Store - API Manager 1.7.0 - WSO2 Documentation

All docs This doc
Skip to end of metadata
Go to start of metadata

There are several ways in which you can customize the look and feel, features and functionality of the API Store as discussed below:

Changing the theme

You can change the look and feel of your API Store by applying new themes or customizing the default theme's logo, footer notes, About page etc.

The default API Store theme is inside <AM_HOME>/repository/deployment/server/jaggeryapps/store/site/themes folder. You can override it by adding your customizations inside /repository/deployment/server/jaggeryapps/store/site/themes/fancy/subthemes folder. Follow this tutorial in WSO2 library for instructions to change the theme:

If you are using a Cloud-based API Manager setup (e.g., WSO2 API Cloud) and do not have access to the distribution directory, you can change the theme by logging into the WSO2 Workflow Admin Web application (https://<Server Host>:9443/workflow-admin) as a tenant admin. Bundle the new theme (CSS, images etc.) into a zip archive and upload it through the Workflow Admin Web app.

Changing language settings

You can change the language of the API Store Web interface to your local language. For configuration steps, see Adding Internationalization and Localization.

Single login for all apps

You can configure single sign-on (SSO) in API Manager so that users who are subscribed to one application can log in to multiple other applications that they are authorized to access, using the same credentials. They do not have to repeatedly authenticate themselves. For configuration steps, see Configuring Single Sign-on with SAML 2.0.

Categorizing APIs

API providers add tags to APIs when designing them using the API Publisher. Tags allow API providers to categorise APIs that have similar attributes. Once a tagged API gets published to the API Store, its tags appear as clickable links to the API consumers, who can use them to quickly jump to a category of interest.

If you want to see the APIs grouped according to different topics in the API Store, do the following:

  1. Go to <APIM_HOME>/repository/deployment/server/jaggeryapps/store/site/conf directory, open the site.json file and set the tagWiseMode attribute as true. 
  2. Go to the API Publisher and add tags with the suffix "-group" to APIs (e.g., Workflow APIs-group, Integration APIs-group, Quote APIs-group.)
  3. Restart the server.

After you publish the APIs, you see the APIs listed under their groups. You can click on a group to check what the APIs are inside it.

  • No labels