Skip to Content

Designing a great API developer experience (DX)

Streamlining API discovery: The consumer portal story

Empowering developers with streamlined processes and cutting-edge tools that allow them to focus on what they do best - building efficient solutions.

DX Design

Role

Interaction Design

UX Strategy

Visual Design

Design system

Prototyping

Tools

Figma

Figjam

Duration

5 months

Project overview 

The company is embarking on a strategic pivot to position APIs as a core product,  emphasizing integration and enhancing developer experience (DX). This shift reflects the company's commitment to staying competitive in the evolving digital landscape by leveraging APIs as key enablers of innovation and collaboration. With a focus on integration and DX, the company aims to streamline processes,  foster innovation, and deliver exceptional value to developers and end-users alike.

Strategy

To make APIs a core product and enhance the developer experience (DX), we are focusing on two key pillars:

  1. Strong Foundation: We are building a flexible and scalable system that makes API integration easy and future-ready. This ensures that developers can build and innovate without technical roadblocks.
  2. Great Developer Experience: Our goal is to make APIs intuitive and effortless to use. By improving API documentation, designing user-friendly portals, and providing strong support, we aim to help developers work efficiently and confidently.

Achieving the second goal, enhancing customer experience, means designing a developer portal that truly meets their needs. This requires a deep understanding of our users, gathering feedback, and continuously improving the platform. By doing so, we create an environment where developers can easily discover, integrate, and succeed with our APIs.

Steps taken

Competitor
analysis

Analyzed competitor devportals for baseline inspiration through the lens of Verizon Brand.

Customer needs assessment

Captured needs from would-be customers to establish a roadmap and define an MVP.

Persona development

Created Personas to encapsulate the needs of distinct customer types and user journeys to pinpoint their pain points and aspirations.

Information architecture (IA)

Translated 1-3 into an information architecture that structures the portal experience in a manner that intuitively and frictionlessly meets customer needs.

Homepage layout drafting​

Drafted an initial consumer portal homepage layout.

Competitor analysis - devportals

Competitor analysis - core features & best practices

1. Global navigation that prioritizes the site's most common content and actions

2. Homepage that frames its purpose and spotlights key API products and services

3. And these features… 

Catalog Searchable, well-organized directory of APIs that makes it easy to find the right one.

Docs Collection of technical info and  user guides to enable integration with the platform using APIs.

Sandbox Emulates the behavior of a production API and enables quick, risk-free API evaluation.

Dashboard Delivers clear and actionable insights on API usage and adoption.

Resources Content-rich compendiums of self-serve info to boost the developer experience.

Search Readily accessible and well integrated with API docs and educational content

Help center Hub for knowledge-base material and outreach touchpoints


Competitor analysis - Homepage navigation

Competitor analysis - Anatomy of a homepage

Understanding the API ecosystem (Customer needs overview)

API ecosystems have two primary user groups:

  1. Producers – Those who design, develop, and release APIs.
  2. Consumers – Those who discover, evaluate, and use APIs.

These journeys interlock at the Release & Distribute stage of the Producer Journey, where APIs become available for discovery by consumers.

APIs are essential for modern businesses, but various challenges hinder their adoption and efficiency.


🎯 Key Challenge:

Discoverability Issues → Users struggle to find the right APIs quickly.

Documentation Gaps → Inconsistent or unclear API documentation leads to inefficiencies.

Onboarding Complexity → Developers find it hard to get started with APIs due to unclear processes.

Versioning & Updates → Keeping track of API changes is cumbersome, leading to broken integrations.


Who Faces These Issues?

Developers, API Architects, Engineering Managers, etc.


Mapping UX challenges to product roadmap

To improve API discovery, our UX strategy involved:

  • Mapping each phase of the Consumer Journey to product initiatives.
  • Identifying pain points in discovery, evaluation, and usage.
  • Defining actionable design solutions (e.g., homepage redesign, search improvements).

    Example:
    For the Discovery phase, we focused on redesigning the API portal homepage to improve first impressions and findability.

    UX Considerations:
  • How easily can developers find relevant APIs?
  • Is the portal experience intuitive enough for quick evaluation?
  • Do APIs provide the right level of documentation and support?

The homepage, acting as the gateway to the developer portal, sets its purpose and caters to developers' requirements from discovery to utilization and beyond. It highlights essential API products and services for developers.

Other pages execution

Products pages supply an overview of API capabilities, with curated galleries that are eminently discoverable. 

Documents features a consistently-structured and clearly-organized library of all API technical documentation. 

Components

During the development of the developer portal, we encountered several instances where existing components from the company's design system did not fully meet the specific requirements of the project. As a result, we embarked on creating custom components tailored to the unique needs of the developer portal.

Results & learnings

Throughout this project, the implementation of custom solutions resulted in a notable increase in developer engagement, alleviated integration hurdles, and significantly enhanced the overall user experience. Following the release of the Minimum Viable Product (MVP), the feedback from developers was overwhelmingly positive, with many expressing satisfaction with the developer portal's usability and functionality. While the site elements received favorable ratings, the need for improved information clarity emerged as a key focus area for future enhancement.

The iterative process of testing, refining, and implementing these features provided invaluable insights into user behavior and preferences, guiding future enhancements and reinforcing the foundation of the API portal. This journey underscored the importance of user-centric design, proactive problem-solving, and continuous improvement in delivering a robust and effective developer ecosystem.

It is worth noting that the product remains under continuous enhancement, with new features and updates being introduced in each sprint/phase. Additionally, efforts are underway to design a producer's portal, further expanding the scope and reach of our API ecosystem. We are excited about the journey ahead and remain committed to delivering innovative solutions that empower developers and drive digital transformation. 

Thank you for joining us on this journey!