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

Vanity URL: A Step-by-Step Guide to Creating Vanity URLs in IBM API Connect SaaS

By Shihabudheen K M posted Mon December 11, 2023 10:40 PM

  

 Introduction

IBM APIConnect as a Service now allows users to customize Vanity API endpoints when creating a Catalog. This capability allows organizations to customize their API endpoints for both the portal and APIs, providing enhanced flexibility and enabling a more personalized and branded user experience.

By configuring a vanity URL in API Connect, you can create branded and memorable web addresses that align with their organization's identity or specific API use cases. This customization is particularly advantageous in scenarios where user engagement and brand recognition are pivotal. API Connect enables organizations to design, secure, and manage APIs seamlessly, and incorporating vanity URLs adds an extra layer of customization.

The process of configuring a vanity URL in API Connect typically involves the following steps:

1. Configure the vanity API endpoint in your catalog:

Step 1: Set up the vanity hostname:

    • Set up your desired DNS as a CNAME pointing to the following address: custom.<region>.apiconnect.ibmappdomain.cloud
      where <region> is the region where your API Connect account is hosted.
      For example, for an       eu-central customer the CNAME is custom.eu-central-a.apiconnect.ibmappdomain.cloud
      you can also copy it from vanity API Endpoint configure page 

    Step 2: Configure the vanity API endpoint in your catalog:

    • In the catalog, click the Catalog Settings tab.
    • On the Catalog Settings page, click API endpoints in the navigation list.

           

    • On the Vanity API endpoint page, click Edit button.
      • In the "Endpoint URLs" section, select Use vanity hostname.

        When you select this option, a reminder to configure the CNAME for your vanity hostname displays.
        If you did not already configure the CNAME, click copy icon in the message to copy the URL so that you can use it to configure the CNAME.

      • Type the new vanity hostname DNS for your API endpoint; for example:  demo-vanity.your-domain.com
      • Upon clicking the "Check DNS" button, the system will validate the entered vanity URL for accessibility. If the verification is successful, a success message will be displayed, and the "Save" button will be enabled.

      • Following a successful DNS check, click the "Save" button to initiate the creation of vanity resources for API endpoints.
        Please allow a few minutes for the resources to be fully prepared before users can access the Vanity URL.

      • If you later want to remove the vanity API endpoint, you can edit the vanity API endpoint settings to select the default gateway option.

       

    2. Configure the vanity API endpoint for your Developer Portal:

    Step 1: Set up the vanity hostname:

      • Set up your desired DNS as a CNAME pointing to the following address: custom.<region>.apiconnect.ibmappdomain.cloud
        where <region> is the region where your API Connect account is hosted.
        For example, for an         eu-central customer the CNAME is custom.eu-central-a.apiconnect.ibmappdomain.cloud
        you can also copy it from vanity API Endpoint configure page 

      Step 2: Configure the vanity hostname for the Developer Portal:

      • In the catalog, click the Catalog Settings tab.
      • On the Catalog Settings page, click Portal in the navigation list.
      • On the Portal page, click Create button if already have a portal click on Edit.

      • In the "Portal site" section, choose the option "Use vanity hostname."

      • Upon selecting this option, a prompt will appear, reminding you to configure the CNAME for your vanity hostname. If the CNAME has not been configured yet, click the Copy icon in the message to copy the URL, which you can later use for CNAME configuration.

      • Enter the new custom hostname DNS, for instance, demo-vanity.dns.com

        • Click "Check DNS" button, the system will validate the entered vanity URL for accessibility. If the verification is successful, a success message will be displayed, and the "Save" button will be enabled.
        • When the DNS check succeeds, click Save.

          The Catalog Settings page displays the settings for the updated portal.

        •    After few minutes you can use the developer portal
        Note: Please be aware that it may take a few minutes for the resources to be fully prepared, allowing users to access the Developer portal via the custom vanity URL.

        Benefits of configuring a vanity URL in API Connect include:

        • Branding: Reinforce your brand identity by incorporating organization's name or relevant keywords directly into the URL.

        • User-Friendly: Create short, memorable URLs that are easier for you to remember and share, promoting a positive user experience.

        • Promotion and Marketing: Tailor URLs to specific campaigns, events, or promotions, allowing for easy tracking and analysis of user engagement.

        • Consistency Across APIs: Maintain a consistent and professional appearance across different APIs or products, enhancing overall brand cohesion.

        Conclusion

        In summary, configuring Vanity URLs in API Connect provides a strategic and user-friendly way for organizations to enhance the visibility and accessibility of their APIs and portals. This feature allows the creation of branded and memorable web addresses, reinforcing brand identity and improving user engagement. The process involves DNS checks and the creation of custom resources, contributing to a polished and user-centric API management strategy that prioritizes a seamless and personalized experience for API consumers.

        0 comments
        43 views

        Permalink

        https://community.ibm.com/community/user/blogs/shihabudheen-k-m/2023/12/11/httpsibmapimslackcomarchivesc0322gz83s6p1701231877