Versions Compared

Old Version 9

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  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  and <AdminPassword> to the credentials of the super admin, or if you are in a multitenant setup and you are not the super admin, to the tenant admin's username and passwordcredentials. Note that the super admin's credentials are admin/admin by default. If you changed the default super admin's credentials, using admin/admin will cause errors.
    Code Block
    languagexml
    <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><EnableSignup> element to false. 

...

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

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

...

  1. Log in to the API Store and note the APIs listed under their groups. You can click on a group to check what the APIs are inside it.
    Image Added

Customizing the API group

If you want to change the descriptions and the thumbnail images that come by default, do the following:

  1. Log in to the Management Console and click the Resources -> Browse menu to open the registry.
    Image Added
  2. Create a collection named tags under the registry location /_system/governance/apimgt/applicationdata.
    Image Added
  3. Give read permission to the system/wso2.anonymous.role role.
    Image Added
  4. Add each tag as collections under the tags collection (e.

...

  1. g., Workflow APIs-group, Integration APIs-group, Quote APIs-group.)
  2. Navigate to each tag collection and upload the following:
    • description.txt with the description of the tag
    • thumbnail.png for the thumbnail image
  3. Back in the API Store, note the changes you did in the registry.