In the previous blog we discussed about the positioning and value proposition of API Business Hub Enterprise. In this blog we will see how API portals can be configured and publish APIs to API Business Hub Enterprise.
Configure Connectivity to API Business Hub Enterprise
Till date, API portal is publishing APIs to the Developer Portal in the same sub-account/tenant. With rebranding of Developer Portal to API Business Hub Enterprise, multiple API Portals can publish APIs to any of the subscribed API Business Hub Enterprise (same or the other sub-account/tenant) in CF environment.
Customers with multiple instances/tenants of SAP API Management/Integration Suite, depending on the business scenario may decide to publish the API content which is provisioned in different API Portals to centralized API Business Hub Enterprise.
“AuthGroup.APIPortalRegistration” role should be assigned to the respective API Portal Admins who all can request for a connection to API Business Hub Enterprise. This role assignment will be done in the sub-account where API Business Hub Enterprise is subscribed.
API Portal Admin request workflow
- API Portal Admin will initiate a ‘Connection Request’ in API Business Hub Enterprise.
2. Create a new connection request.
3. Once connection request is successful, you cannot connect API Portal to any other API Business Hub Enterprise.
4. In the Connection Request page, fill the below listed details:
- API Portal Alias Name: This name will appear in the API Business Hub Enterprise in Developers workspace and while creating an application to categorize the API products. We encourage to use names as per the business scenario. Eg: In this blog we will be publishing API products for Line of Business dealing with travel and Expense. So, API Portal Alias name chosen is: Travel Expense.
- API Portal Access Credentials: To establish two-way connectivity, API Portal connectivity credentials should be shared with API Business Hub Enterprise application.
- Comments: (optional) Reason for this connection request to API Business Hub Enterprise Admin.
How to get the API Portal Access Credentials?
(for permissions and how to enable service plan please refer SAP help documentation)
a) In Cloud cockpit, within cloud foundry space, select ‘API Management, API portal’
b) Create a service instance.
- Select the Service Plan – apiportal-apiaccess
- Unique instance name : instance-1
- Specify the parameter in JSON format
c) Once instance is created, Create a service key.
d) Click on ‘View Credentials’ of the created Service Key.
e) Copy JSON which will be used ‘API Portal Access Credentials’ of Connection Request page.
“Once JSON is copied we could resume step 4 to submit Connection Request.”
5. Connection request will remain in submitted state till its either approved or rejected by API Business Hub Enterprise admin
6. Once Approved, status of the request will change to ‘Approved’ listing the connectivity status
API Business Hub Enterprise Admin Approval workflow
1. In the Manage tab, API Business Hub Enterprise Admin (with a role: AuthGroup.API.Admin) could navigate to ‘Manage API Portal Connections’ tile to approve or reject the request.
2. In Pending Requests section, a new entry will appear which Admin can approve it with the comments.
3. Once approved, it will appear in the Approved Request section
4. Likewise, all the approved request (connected API Portal) will list in ‘Approved Requests’ section.
5. API Portal which is in the same sub-account/tenant of API Business Hub Enterprise will be listed as Default API Portal. Its name can be edited based on Business scenario. In our current example, this API portal will be publishing APIs of HR LoB so we named it Human Resource as this name will get displayed in API Business Hub Enterprise in Developer Workspace and categorizing API products which subscribing and creating an application.
Developer onboarding and API consumption experience remain same. Developers will see the APIs which would have been published from all the connected API portals.
1. API Business Hub Enterprise Home page will list API products
2. Click on any of the listed tile (Recruiting) to view all the APIs within it.
3. Click on subscribe to create a New Application.
4. My Workspace will list the created application. This application will have the application key and secret.
5. Likewise, subscribe to another tile ‘Employee central’ in the Home page.
6. My Workspace will list all the created applications.
7. Click on any of the created application to get the application details like application key, secret.
We have started the API Business Hub Enterprise journey and will keep on sharing the new incremental value additions.