Lab 06 - API Developer Portal

Return to Workshop

Lab 6

API Developer Portal

Publishing APIs to Developer Portal




Overview

The focal point of your developers experience is the API developer portal, and the level of effort you put into it will directly correlate to the level of success of your API program, and API developer engagement.

Why Red Hat?

Red Hat 3scale API Management Solution provides a built-in, state-of-the-art CMS portal, making it very easy to create your own branded hub with a custom domain to manage developer interactions, and help increase API adoption.

You can customize the look and feel of the entire Developer Portal to match your own branding. You have complete control over every element of the portal, so you can make it as easy as possible for developers to learn how to use your API.

Lab Instructions

Step 1: Customizing Developer Portal

  1. Open a browser window and navigate to the 3scale admin app. Please check with your instructor.

  2. Log into 3scale using your designated user and password. Click on Sign In.




  3. Click on the Developer Portal tab to access the developer portal settings.




  4. Click on the Visit Developer Portal to take a look of how your developer portal looks like.




  5. You can see there is a default portal with information on your API, and how to signup. Unfortunately the API information is incorrect.




    We will edit our portal to update it with the correct information, and we will add the cool shadowman logo.

  6. Go back to your admin portal browser tab and scroll down to the content sub-sections for the Layouts and select the Main layout menu option.




  7. First look for the navbar section of the main HTML. Replace the {{ provider.name }} for the shadowman image link:

    <img src="https://www.redhat.com/profiles/rh/themes/redhatdotcom/img/logo.png" alt="{{ provider.name }}">




  8. Click the Publish button at the bottom of the editor to save the changes and made them available in the site.




  9. Go back to browse the top of the content sub-sections and find the Homepage section.




  10. Change all the code Echo references in the homepage code for Office Locations.

  11. Click the Publish button.

  12. Refresh your Developer Portal's browser tab to check the changes. Your Developer Portal should now look like this:




Step 2: Register New Accounts Using Developer Portal

  1. Take the place of one of your developers and signup for the Basic plan.




  2. Fill in your information and an email to register as a developer. Click on the Sign up button.




  3. The system will try to send a message with an activation link.




    Currently the lab environment doesn't have a configured email server, so we won't be able to receive the email.

  4. Go back to your Admin Portal tab and navigate to Developers to activate the new account.




  5. Find your user under the Accounts and click the Activate link.




    Your user is now active and can log into the portal.

Step 3: Login to Developer Portal

  1. As your portal is not currently public, you will need your portal code to login. You can get the code in your admin portal navigating to: Settings > Developer Portal > Domains & Access.




  2. Open a new Incognito/Private browser window to test the Developer Portal login. Navigate to the following. Make sure your user and Openshift environment is correct.

     http://[userX].apps.[OCP_URL]
    
  3. Type your portal code to finish the login.




  4. Sign in to the portal.




  5. You will land in the developers homepage, where you will be able to check your developers settings and retrieve your newly created Client ID and Client Secret.




Congratulations! You have successfully customized your Developer Portal and completed a Sign Up process.

Steps Beyond

So, you want more? Click the Documentation link. Where does it takes you? API Docs is where you can add your interactive documentation for your APIs. Is based on the known Swagger UI interface.

You can add from the Admin Portal under API Docs the API definition to generate the live testing.

Summary

In this lab you discovered how to add a developer facing experience to your APIs. Developers in your organization or outside of it can now register, gain access to API keys and develop sample applications.

You can now proceed to Lab 7

Notes and Further Reading

Red Hat 3scale Developer Portal's CMS consists of a few elements:

Liquid is a simple programming language used for displaying and processing most of the data from the 3scale system available for API providers. In 3scale, it is used to expose server-side data to your API developers, greatly extending the usefulness of the CMS while maintaining a high level of security.

Return to Workshop