Customizing the API Store

You can customize the API Store in the following ways:

Enabling or disable self sign-up

In a multi-tenanted API Manager setup, self sign-up to the API Store is disabled by default to all tenants except the super tenant. A tenant admin can enable it as follows:

1. Log in to the management console (https://<HostName>:9443/carbon) as admin (or tenant admin).
2. Click the Configure -> Users and Roles menu. 
   

3. In the User Management page that opens, click Roles.
   

4. Add a role by the name subscriber (or any other name you prefer) and the following permissions:
   

   • Login
   • Manage > API > Subscribe

    
5. Go to the Resources -> Browse menu.

6. Load the /_system/governance/apimgt/applicationdata/sign-up-config resource in the registry browser UI.
   

7. Do the following changes in the signup configuration and save.

   • Set <EnableSignup> to true.
   • Set <RoleName> to subscriber and <IsExternalRole> to true. Note that you must have the subscriber role created at this point.
   • Set <AdminUserName> and password to the tenant admin's username and password.

   <SelfSignUp>
       <EnableSignup>true</EnableSignup>
       <!-- user storage to store users -->
       <SignUpDomain>PRIMARY</SignUpDomain>
       <!-- Tenant admin information. (for clustered setup credentials for AuthManager) -->
       <AdminUserName>xxxx</AdminUserName>
       <AdminPassword>xxxx</AdminPassword>
       <!-- List of roles for the tenant user -->
       <SignUpRoles>
           <SignUpRole>
               <RoleName>subscriber</RoleName>
               <IsExternalRole>true</IsExternalRole>
           </SignUpRole>
       </SignUpRoles>
   </SelfSignUp>

8. Restart the server and open the API Store (https: //<HostName>:9443/store.)

9. Note the Sign-up link that appears in the top, right-hand corner of the window.
   
10. To disable the self signup capability, navigate to/_system/governance/apimgt/applicationdata/sign-up-config.xml in the registry again and set the <SelfSignUp><Enabled> element to false. 

Changing the theme

See Adding a new API Store Theme.

Changing language settings

To change the language of the API Store, see Adding Internationalization and Localization.

Setting single login for all apps

Single sign-on (SSO) allows users who are logged in to one application to automatically log in to multiple other applications using the same credentials. They do not have to repeatedly authenticate themselves. To configure, see Configuring Single Sign-on with SAML2.

Categorising and grouping 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.