Hi, my name is Denys van Kempen, SAP HANA Academy.
You are watching a video tutorial that is part of a series about the SAP Business Technology
Platform, SAP Integration Suite certification, covering API Management.
This video was recorded in March 2022.
For the latest tutorials on the topic, please check the playlist.
In the previous video we covered how to activate the API Management capability and covered
some of the concepts.
In this video, we show you how to add an API provider, create an API proxy, and publish
a product using the API Portal.
Next, we subscribe to the product, create an application that is, using the developer
portal also known as the API Business Hub Enterprise.
As API provider, we will be using an open connector instance pointing to Slack, which
we created in a previous video.
I am connected to the API portal.
To add an API provider, select the artifact on the Quick Actions tile on the Home page
or, alternatively, navigate to the Configure menu and select Create.
Same thing.
Here it now says Add API provider and we are in the Configure menu, which provides an indication
that we are not really creating all that much, we are merely adding a connection to some
back-end system, similar to Destinations on the SAP Business
Technology Platform . There are four connection types,
the API source could be the Cloud Integration tool (capability) of the suite, Open Connectorsa
Cloud Connector configuration on the SAP Business Technology Platform referencing an SAP ABAP
(NetWeaver) system on-premises, or any public internet source.
When we select Open Connectors, we need to provide the region, a region, cloud provider
combination, in fact, where the Open Connectors tenant is hosted.
the cloud provider is not mentioned in the list unfortunately, which makes it a bit more
difficult to select the right one.
So make sure to double check the subaccount used to provision the Integration Suite.
Standard TLS port 443 for secure (encrypted) communication and then we need to provide
the organization secret and user secret of the Open Connectors tenant
We have covered this in a previous video where we created a connector instance, the gear
icon in the left pane provides access to your profile, although branded with the SAP business
technology platform color scheme, you may have noticed that the user interface
of Open Connectors is a bit different compared to some of the other tools of the suite
under the hood, the service is provided by a company called Cloud Elements.
Copy the secrets and paste them in.
Save As a reminder, the advantage of using Open
Connectors here, instead of the internet type, is that it provides a common configuration
for 160, 170+ connections to non-SAP third-party systems.
So, whether you want to connect to Slack, Amazon, Azure, Facebook, Github, Google, Hubspot,
and so on, the setup is all the same.
Just provide the region and secets.
After we added an API Provider, we can switch to the Develop menu and create an API, also
known as API proxy.
Select API provider as origin, as source Select the API provider we just created from
the list and using the Discover button, we can query Open Connectors for some metadata.
An instance is found.
Select it, and the API details are populated automatically, the URL, name, title, state,
host alias, API base path, to which we can add a version, for example and select Create.
Make adjustment if needed and save.
API registered successfully.
Now, there is a lot more to developing APIs but this is not in scope for the exam in any
detail, so we will skip this for now and cover this, again, as some bonus material in another
video.
Back to the list.
From the Actions menu, select deploy As API developer, we can test the API in the
API Test Console, select the API, select the request, the call, the verb.
You can add headers, URL parameters Send
200 OK We do not need to authenticate, as the authenticaiton
is being done by the Open Connector instance.
We can check the response body, the headers, there is a debug option, but for more advanced
API testing, you probably would use a tool like Postman
Back to the Develop menu.
Now that we have deployed the API, we need to make it accessible to the outside world,
and for this we need to create a product.
We covered the concepts in the previous video, assume this to be familiar.
Give it a name and title, we will see the title when we switch to the developer portal
later on.
In the product we can define quotas, permissions, and rate plans, although none are required,
add one or more APIs, select from the list, you can select a specific path, or the entire
node, with the observation that a product would typically reflect a certain business
use case, a scenario, but this is up to you as API developer.
Next we need to publish the product, recall that API are deployed and product are published
making it possible for the application developer to subscribe to the product.
For this we need to switch interfaces, as we are also switching personas from the API
developer to the app developer.
The Applications view here in the Develop menu of the API Portal is read-only, showing
no data, as we have not created any application yet.
Before we switch, back home for a quick recap.
We added an API provider of type Open Connectors used this as source for an API, which we deployed
and then added to a product, which we published.
Next, switch to the API developer portal called API Business Hub Enterprise
Home lists all published products, which we can select and explore,
Similar to the public SAP API Business Hub portal, api.sap.com, same navigation, same
concepts, at least when using the old interface of the hub
Before we can subscribe to a product, we first need to manage users
You may recall there were seven different role collections for the developer portal,
one to deploy, one for administration.
The admin needs to register users and assign roles.
Administrator, content administrator, application developer, site administrator with a link
to the documentation where the role collections are explained in more detail.
No need to memorize, but why they exist should be clear, if not.
Consider reviewing the concepts video in the playlist.
You may recall that we already assigned all role collections to this particular user in
the BTP Cockpit, So, why do we need to perform this action
manually again in the Developer portal?
That’s because API Management is powered by apigee, a partner company, under the hood,
and for the dev portal this security configuration is not synchronised
Also recall that the API Business Hub Enterprise, the developer portal, is an optional part
of the API Management capability.
Now that we have the required developer privileges, we can navigate to the My Workspace menu and
create an application.
Give it a name.
There are some options, create the application on behalf of someone else, indicate that you
already have key and secret Recall that via the key and secret API usage
is being monitored, add one or more products, which may or may not contain quotas, rate
plans, or require authorisation Here we can see the secret and key for this
application, which can be regenerated if needed.
Some analytics information for the application, for the developer workspace
Returning home, select the product, select the API.
Let’s try it out.
Paste in the authorization key, unique to our subscription, to our app, execute, 200,
everything appears to be working.
Let’s try and create a channel, provide authorisation, and a name, 200.
Let’s copy the ID and now let’s see whether we can post any messages to the channel, paste
in authorisation and channel ID, a text string, and execute, 200, and when we switch to Slack,
we can see the channel and message created.
Very well, there is a test console for the app developer as well.
Same functionality as in the API portal, but again, don’t be surprised when the developers
are using Postman instead, as it is farily basic.
Back to the Portal Develop
Applications The subscription is listed and the developer,
with key and secret and some additional information.
For the API administrator, there is an Analyze menu, showing KPIs, API health and usage
That’s it for API Management, what you need to know.
This video tutorial was recorded by Denys van Kempen, SAP HANA Academy.
Any good?
Give us a like, and for updates, don’t forget to subscribe.
Thanks for watching.