API Connect

API Connect

Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.

 View Only

APIC Connect Developer Portal showcasing your APIs with the new Case Studies module

By Anne Redwood posted Thu December 19, 2024 12:04 PM

  

This currently applies to IBM API Connect version 10.0.9+

Introduction

In seeking to enable the business users of the Developer Portal we have added a new content type Case Study.  An API Developer Portal can greatly benefit from incorporating case studies, as they provide evidence of the value and capabilities of the API Products provided. Case studies can showcase real-world applications and use cases, enabling developers and business users to visualize the potential of the API Products in their own solutions. This can accelerate the learning process and encourages faster adoption of API Products.

Case studies can highlight the API Product's differentiators and unique features, fostering a deeper understanding of its advantages over competitors. Ultimately, well-crafted case studies serve as powerful tools for engaging business owners and developers, demonstrating value, and driving successful implementation in various industries.

Case Studies

The content of a case study can include a summary and description of the Customer use case to highlight the associated products. Content included in the case study page can include the original problem that needed addressing, the solution that was enabled using the associated API Products featured and any success indicators or improvements in the business using the API Products.
Sample Case Study explaining the challenge, solution, success and API products used
The associated products are linked to the in the content of the case study if specified.  Also, if a product is referred to in a case study then the that is automatically linked to in the featured Product page.
Sample product page with case studies.
How to create a case study is described the IBM Documentation.

Case Study view

Case studies are listed on their own view page.

All Case Studies listed
This can be accessed from a new block added to the default Welcome page or you can add the link to the view to your own menus.

Case study block on the Welcome page

Similarly to products and the Featured Content bock, if there is case study content created then a selection of case studies can be shown in a block on the default home page.

Case Study block on the home page
This block can be configured to show a specified number of Case Study tiles, the Case Study tile selection criteria (for example, based on creation or modification time or name) as well as order in which the block itself is displayed. See how to do this in IBM Documentation.
Configuring the case study homepage block
Note:

In the v10.0 release of API Connect, the Case Studies modules is enabled out of the box, but in v10.0.8 this module will need to be enabled if you want to make use of it. Logging in as admin and navigating to Extend, filter on "Case Study", select the checkbox next to the module and click the Enable button.

If disabling the module then, please be aware that any Case Study content previously created will be deleted as well.

API Connectdeveloper portalIBM API Connect

0 comments
12 views

Permalink

https://community.ibm.com/community/user/blogs/anne-redwood1/2024/12/18/developer-portal-case-studies