

Enable Social Media Interaction

By default, the community links option is disabled (hidden). As a result, the sharable Developer Portal links of the APIs for Facebook, Twitter, and Reddit will not appear in the Developer Portal by default. Instead, the administrators have to enable the social media sharing option if they wish to allow API Consumers to use this feature.

In addition, the GitHub and Slack channel URLs will not appear in the Developer Portal unless the administrators have defined these URLs via the Publisher.

• Enable Social Media Interaction
• Enable sharing API link on social media
  • Step 1 - Enable the community links option
  • Step 2 - Verify the changes
• Add GitHub and Slack channel URLs to an API
  • Step 1 - Define your GitHub and Slack channel URLs
  • Step 2 - Verify the changes

Enable sharing API link on social media

Follow the instructions below to enable API Consumers to be able to share the API link on Facebook, Twitter, and Reddit via the Developer Portal:

Step 1 - Enable the community links option

1. Open the <API-M_HOME>/repository/deployment/server/webapps/devportal/src/main/webapp/site/public/theme/userTheme.json configuration file in the MWARE ESB server.

   Note

   • The default configuration comes with an empty configuration object declaration. You can override the default configuration in the userTheme.js file.

   • For more information on the content that is in the default configuration, see Overriding the Developer Portal theme.

2. Enable the community links option.

   {
       "custom": {
           "social": {
               "showSharing": {
                   "active": true
               }
           }
       }
   }

Step 2 - Verify the changes

1. Sign in to the Developer Portal.

   https://<hostname>:9443/devportal

   For testing purposes, you can use https://localhost:9443/devportal and admin as the username and password.

2. Click on any published API to view its details.

   The social media sharable links and the email composer link appear along with the iframe code embedding of the API.

   

Add GitHub and Slack channel URLs to an API

Follow the instructions below to enable the API related GitHub and Slack channel URLs to appear in the Developer Portal:

Step 1 - Define your GitHub and Slack channel URLs

1. Sign in to the Publisher.

   https://<hostname>:9443/publisher

   https://localhost:9443/publisher

2. Click on any published API to view its details.

3. Click Basic info.

   

4. Provide your GitHub and Slack channel URL in the respective input fields and click Save

   

Step 2 - Verify the changes

1. Sign in to the Developer Portal.

   https://<hostname>:9443/devportal

   For testing purposes, you can use https://localhost:9443/devportal and admin as the username and password.

2. Click on the API.

   The API's overview page appears with the GitHub and Slack channel URLs.

   

   Now, API Consumers can use the GitHub and Slack channel community links to engage in community activities, explore the API source, and much more.

Top