In this lab, you will customize the API developer portal
Audience: API Owners, Product Managers, Developers, Architects
Overview
The focal point of your developers’ experience is the API developer portal, and the level of effort you put into it will determine the level of decreased support costs and increased developer engagement.
Why Red Hat?
3scale 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 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.
Credentials:
Your username is: {user-username}
Your password is: openshift
-
Switch to the web browser window, displaying the console for the Red Hat 3scale API Management Platform.
-
Log in to 3scale Admin web console using
{user-username}and password:openshift. Click on Sign in.
-
Select 'Products' from the dropdown menu and Select the SSO Location API.
-
Click on the Applications on the left menu. Select Application plans from the listed dropdown.
-
Publish your application plan by clicking on the kebab menu and selecting Publish.
-
Navigate back to the 'Dashboard' and Click on the Developer Portal tab to access the developer portal settings.
-
On the left menu select Home Page, and replace the entire content with what’s in the example link: example
-
Click the Publish button at the bottom of the editor to save the changes and made them available in the site.
-
Go back to your Audience. Click on the Visit Portal to take a look of how your developer portal looks like.
-
The Developer Portal should show the Location API and the Secure plan with a sign up button.
Were you able to customize the developer portal?
Try to redo this section, if any problem persists have your instructor check the Kubernetes pod that contains the 3scale API Management application.
-
Take the place of one of your developers and signup for the Secure plan.
-
Fill in your information and an email to register as a developer. Click on the Sign up button.
-
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.
-
Go back to your Admin Portal tab and navigate to Audience to activate the new account.
-
Find your user under the Accounts and click the Activate link.
Your user is now active and can log into the portal.
-
Now we need to make sure the the application will redirect the user to the correct page after successful login. Go to the Developer tab and click on SIGN IN.
-
Login as the user you have created in the previous step.
-
Click on See you Applications & their credentials link.
-
Select the application for the
SSO Location APIservice
-
Update redirect link to
http://www-{user-username}.{openshift-app-host}/*
Copy down the client id and client secret credentials as it you will use them to authenticate yourself to the managed API.
Were you able to activate your user account?
Try to redo this section, if any problem persists have your instructor check the Kubernetes pod that contains the 3scale API Management application.
Congratulations! You have successfully customized your Developer Portal and completed a Sign Up process.
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.
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.
Red Hat 3scale Developer Portal’s CMS consists of a few elements:
-
Horizontal menu in the Admin Portal with access to content, redirects, and changes
-
The main area containing details of the sections above
-
CMS mode, accessible through the preview option
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.