Adding a case study

The Community managers and API product owners can use the case study module in the Developer Portal to promote and highlight their published API products.

Before you begin

You must have administrator access to the Developer Portal to complete this task.
Note: This module will only synchronize the credentials of applications created by consumers in the Developer Portal site UI. It cannot synchronize the credentials for applications created by the provider in the API Manager UI.

About this task

The case study module offers valuable context and practical examples to highlight how the APIs published in their Developer Portal addresses real-world business challenges. The module also highlights the success stories of the users who have integrated these API products into their application.

Create a case study

Complete the following steps to create a new case study:
  1. On the Admin dashboard, click Create > Case study.
  2. On the Create case study page, provide the following details:
    1. In the Title field, provide a title for the case study.
    2. From the Language list, select an option. By default, English is selected.
    3. Click Browse to browse and select an image for the new case study and provide an alternative text for the image.
    4. In the Summary field, enter a description for the case study. This information is displayed on the case study tile.
    5. In the Body field, enter the main html body for the case study. This information is displayed on the case study page.
    6. Under Associated API products, start typing the name of your API product in the text box and you can choose from the options that are displayed.
    7. To associate more API products with the case study, click Add another item and repeat step (f).
  3. Click Save.
    The new case study tile is displayed on the Developer Portal home page under Case studies. The tile displays the following details:
    • Case study tile
    • Case study summary
    • Case study image
    To configure the case study module in the Developer Portal, see Configure the case study module.
    Note: The case study module is enabled by default in the Developer Portal.

    To change the front page of the case studies content block, see Changing the case studies content block on the front page.

What you did in this task

You created a case study and the Developer Portal home page now displays the case studies content block. Click the case study tile to view the case study page that displays all the associated API products. Click a product tile to view the corresponding product details page. The following actions are available on both the case study and API product pages:
  • View
  • Edit
  • Delete
  • Revisions
  • Translate