Building & Consuming API’s using SAP API Management (Part 2)
In the previous article Building & Consuming API’s using SAP API Management (Part 1), I showed how easy it is to create API’s and publish them using the API Portal. Now we are going change personas and login to API Management as a Developer.
SECTION 3: DISCOVER API’S TO CONSUME
Developer portal is an application that provides a common platform for Application developers to consume APIs. Every SAP API Management customer is provided with their own Developer portal application on cloud. The Developer portal offers capabilities to onboard application developers, explore and test APIs, create and subscribe to Applications
3.1 Accessing DEV Portal
Navigate to the API Management main menu and launch the DEV Portal
Notice that our new product is already made available in the DEV Portal.
Open the Product and explore the API along with the documentation. Notice that everything generated in the API Portal is automatically translated to the Dev Portal. You can see the operations against each resource including the documentation which was added for each of the resource.
From the Product page, click on Subscribe > New Application
Provide the name for the Application and click on Save button
3.2 Consuming the Application
Navigate to the Consume section to see the App you recently created.
Open the App to locate the Application Key and make a note of this key.
3.3 Testing the API
Navigate to the Test section of the Dev Portal.
• Select the GWDEMO API
• For Authentication, provide Basic authentication with your user/password
• Select the collection as SalesOrderCollection
• Under Header, provide a new variable apikey and paste the application key you copied earlier.
• Test the service by clicking on Send button.
If you didn’t not provide an API Key, you will be given an error message as shown.
Now with your fully configured OData API Proxy, with control policies, and API Key, the API is ready to have an App developed on it!
SECTION 4: Troubleshooting Tips
When creating an API in the API Portal, I was confronted with this error message. It didn’t allow me to Save an API
Similarly when I tried to subscribe to a Product in the Dev Portal, it gave me the below error message.
It turned out that all these errors were due to incorrect role assignments. If you bump into these issues, ensure that additional access is not given to your user account as well as the service user p1940842373.Sounds strange, but it worked for me.
I hope you found this informative.
Very nice, comprehensive walk-through Murali, thank you for sharing, especially liked the troubleshooting tips. Always good to know what to do when one runs into trouble 🙂
Thanks Elijah
Very well articulated - thanks for the detailed blog.
Like the information and testing process on the Policies of SAP API Features..
Regards
Rajesh Pasupula
Thanks Murali, it was very helpful !!
Dear Murali,
Thanks for such a great tutorial.
I'm trying to reproduce your work step by step in my HCP trial account. Everything works great until the test of the API in the Dev Portal. The test of the API in the API portal is successful but every time I try to test the API in the Dev Portal I get "HTTP_CALL_FAILED" error. Do you know if I have to create any kind of destination in Dev Portal for the test console to work?
Thanks and best regards,
Ruben.
Hi Ruben, Thanks. I am not sure why you are getting this error. You should be able to test the API from both Dev Portal/API Portal.You don't need to create an additional destination in DEV portal for the test console. Can you try using the same URL/parameters in a REST client (like Postman) and check the outcome. If you still have the issue, can you please open a discussion in this space with more details/screen captures. Thanks.
Thanks Murali.
API works ok form postman and from API portal. But it doesn't work from Dev portal. I will try to pen a new discusión in this space.
Thanks and best regards,
Ruben.
Nice blog Murali. Quick to work out...
Many thanks,
Anand
Hi Murali,
When I create an application in dev portal there will be an error like
"[Request ID: fac1a26e-4474-4977-83f9- 7ca2dc784c16]Â You are not on-boarded properly as an application developer. Contact administrator to help you on-board."
But I had assign related roles as your part 1. What should I do?
Thank you and best regards,
Leo.
Hi,
it is a little bit late but i had the same issue and maybe this answer can help others too.
I had to add my own user to the registered users and assign the "Developer" role.
Select "Manage Users" -> under "Registered Users" select "Add User".
Best Regards,
Johann
I have a maybe simple question: How can I make an API public? I went through all the publishing steps, but when I access the API URL, the systems prompts for a basic authentication login.
I want to make an API public as in no login is required to access the API. I am struggling to find any material on this as everything related to making an API more restrictive, not less. Am I missing a separate step?
Hi Manuel, Its possible to make an API accessible without login. You would need to add your BASIC Authentication within the Policies. I have seen many blogs cover this topic.
Check this one too
https://github.com/SAP/cloud-api-management-samples/tree/master/authentication/basicauthentication