SlideShare a Scribd company logo
Steph Shin
UX thinking in API design
● Cross-functional teams
● Organized problem spaces not discipline
● Platform product line
● App store billing domain
● Highly technical space
Context: UX designer at Shopify
● Serves third party app developers
● Allows app developers to charge Shopify
Merchants directly through their store account
● Originally built in REST
● Our goal was to build it in GraphQL
● Launch at Shopify Unite 2019
Context: Shopify’s Billing API
How to Embed UX Thinking in Your Next API
“Instead of defining the
structure of responses on
the server, the flexibility is
given to the client.”
– Petr Bela, GraphQL in the age of REST APIs
REST vs. GraphQL
Source: https://medium.com/chute-engineering/graphql-in-the-age-of-rest-apis-b10f2bf09bba
Why would I need to think
about UX for an API?
Application
Programming
Interface
How to Embed UX Thinking in Your Next API
“An API is first & foremost
an interface for people”
– Arnaud Lauret, The Design of Web APIs
Developers are people too.
if API = Interface
and Developer = user
then using API = UX
Start by accepting the fact
that you are NOT the user!
“[Users] are usually very different than
those who write the code, even [when]
they are developers: they have different
backgrounds, experiences with user
interfaces, mindsets, mental models,
and goals. They are not us.”
– Raluca Budiu, You Are Not the User: The
False-Consensus Effect
● Trustworthy & consistent (even if it’s unpredictable)
● Human (even if it’s highly technical)
● Discoverable (even if it’s not the main star)
● Easy & simple (even if it’s challenging & complex)
Great UX should feel...
“Good design, when it’s done
well, becomes invisible. It’s
only when it’s done poorly
that we notice it.”
– Jared Spool
● Who will be using this API?
● What problem does this solve?
● What are the use cases?
● What could get in the way of an enjoyable experience?
● How do users understand the problem space?
Helpful questions to guide the design of
great user experiences:
What does UX look like for
API’s?
Collaborate
Be open to the wealth of insights and
ideas that non-technical people bring to
the technical design process.
NOTE: Discussions can be difficult because words often
hold many different definitions. Diagrams, models or a
glossary could help ensure better alignment.
“Teams that fail,
fail to listen to each other.”
– Brent Summers, Get over yourself: Collaboration is
the secret to great products
Research precedents
Look to related or similar examples to
understand the thinking behind the
solution. Try to piece together what they
learned that led to their decisions.
NOTE: It’s not enough to simply copy. You’ll need to
understand how to apply it to your specific context.
How to Embed UX Thinking in Your Next API
Interview users
Talk to users directly and learn about their
current solutions, their motivations and
their mental models.
NOTE: It’s very easy to fall into biases. Be sure to work
with a researcher whenever possible to avoid influencing
interviewees with leading questions.
Example of a leading question:
“I saw you were having difficulty with the
navigation. What happened?”
Vs.
“What was easy or difficult about getting
to the content you wanted?”
⛔
��
“Leading questions rob us of
the opportunity to hear an
insight we weren’t
expecting.”
– Amy Schade, Avoid Leading Questions to Get Better
Insights from Participants
Model the concept
Map out and visualize the objects &
relationships involved. Use this to align
on the system, taxonomy and schema.
NOTE: Focus on organizing the objects and articulating
how they relate to each other and move through the
system. It’s helpful to think of journeys. Use analogies to
help you illustrate the concepts.
How to Embed UX Thinking in Your Next API
How to Embed UX Thinking in Your Next API
Test out the usability
Whether hi- or lo-definition, find a way to
present and test the core logic and
structures of the API design. This can be
done with, interviews, tree tests, surveys...
NOTE: Be as objective as possible and work with a
researcher when possible to avoid influencing your bias.
How to Embed UX Thinking in Your Next API
How to Embed UX Thinking in Your Next API
How to Embed UX Thinking in Your Next API
Steps to improve user experience
Collaborate
Research precedents
Interview users
Model the concept
Test out the usability
What did I learn?
Naming is hard!
Language has many layers of meaning
steeped in culture, past experiences and
individual biases. Focus on the what the
word represents rather than the specific
words and finalize the terminology later.
Oversimplification can
complicate things
Taking a complex concept and
oversimplifying it can cause problems
when scaling. Try to avoid conflating
similar but separate concepts.
Usage fees in REST
Usage fees in GraphQL
Not all feedback is equal
Find a balance between being descriptive
and prescriptive. You don’t have to act on
every feedback. Decisions should be
informed by the product vision as well as
user feedback and data.
Questions &
compliments welcome
😉

More Related Content

What's hot (20)

PPTX
Mobile Application Workshop - So You Want To Build a Mobile App?
Aaron Saunders
 
PDF
Voxxed days 2015-hakansaglam-codereview
Hakan Saglam
 
PDF
IoT App Development Company India, Hire IoT Developers
IndianAppDevelopers
 
PDF
apidays LIVE Singapore - How we Build APIs and Workflows at Slack by Bear Dou...
apidays
 
PDF
Mistakes to-avoid-api-product
Rahul Dighe
 
DOCX
Industry Experts on How to Build Really Good Mobile Application
IndianAppDevelopers
 
PDF
How much does it cost to build a mobile app?
Jurgis Kirsakmens
 
PPTX
Write what counts. Count What Counts.
Pronovix
 
PDF
Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...
Nordic APIs
 
PDF
Uncovering the unknowns of appium and beyond
Perfecto by Perforce
 
PDF
Busting myths about business apps, low code style
Zoho Creator
 
PDF
Low Code Meets the Enterprise - Low Code AppDev with Oracle APEX
joelkallman
 
PPTX
8 Steps to Creating a Mobile App
Cheryl Lawson
 
PPT
SBP Integrate Smartsheet with Appsheet
Gwen Rymill
 
PDF
Who's using your API?
Bruno Pedro
 
PDF
Flatworld Edge Brochure
Flatworld Edge
 
PPTX
Low code vs. No code: Which is better for web and app development?
Devathon
 
PPTX
Make Your API Irresistible
duvander
 
PDF
Rules For Modern Web App Development
Vajrakaya Technologies
 
PDF
Dev Learn Handout - Session 604
Chad Udell
 
Mobile Application Workshop - So You Want To Build a Mobile App?
Aaron Saunders
 
Voxxed days 2015-hakansaglam-codereview
Hakan Saglam
 
IoT App Development Company India, Hire IoT Developers
IndianAppDevelopers
 
apidays LIVE Singapore - How we Build APIs and Workflows at Slack by Bear Dou...
apidays
 
Mistakes to-avoid-api-product
Rahul Dighe
 
Industry Experts on How to Build Really Good Mobile Application
IndianAppDevelopers
 
How much does it cost to build a mobile app?
Jurgis Kirsakmens
 
Write what counts. Count What Counts.
Pronovix
 
Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...
Nordic APIs
 
Uncovering the unknowns of appium and beyond
Perfecto by Perforce
 
Busting myths about business apps, low code style
Zoho Creator
 
Low Code Meets the Enterprise - Low Code AppDev with Oracle APEX
joelkallman
 
8 Steps to Creating a Mobile App
Cheryl Lawson
 
SBP Integrate Smartsheet with Appsheet
Gwen Rymill
 
Who's using your API?
Bruno Pedro
 
Flatworld Edge Brochure
Flatworld Edge
 
Low code vs. No code: Which is better for web and app development?
Devathon
 
Make Your API Irresistible
duvander
 
Rules For Modern Web App Development
Vajrakaya Technologies
 
Dev Learn Handout - Session 604
Chad Udell
 

Similar to How to Embed UX Thinking in Your Next API (20)

PDF
How to embed UX thinking in API design
stephshin
 
PPTX
Developers are People Too! Building a DX-Based API Strategy Ronnie Mitra, Pri...
CA API Management
 
PDF
02 API Academy - path to success
CHARLES Frédéric
 
PDF
UX Overview for Agile Engineering-Driven Organizations
Jim Jarrett
 
PPTX
Considerations For an API Strategy - Ronnie MItra API Architect Layer 7 Londo...
CA API Management
 
ODP
User Experience Design, talk at the #bizathon
Kiran Subbaraman
 
PDF
UX is for Losers
Federico Pizzutto
 
PDF
Hacking UX: Product Design Thinking for Techies
Melissa Ng
 
PDF
Be My API How to Implement an API Strategy Everyone will Love
CA API Management
 
PDF
Bulletproofing Your APIs: Why Users’ Feedback Matters
Pronovix
 
PDF
Richard Marsh, Enterprising User Experience - Flex and the city
Richard Marsh
 
PDF
UserTesting 2016 webinar: Research to inform product design in Agile environm...
Steve Fadden
 
PDF
Building API Products
James Samuel
 
PPTX
An Introduction to User Experience for Dev's & Techies
Scott Savage
 
PPTX
Applying a Developer-Centric Approach to API Design from API Architect Ronnie...
CA API Management
 
PPTX
Do's and Don'ts of APIs
Jason Harmon
 
PPTX
On the shoulders of giants Learning About API Design by Looking Backwards
CA API Management
 
PDF
UX Research Methods: Behind the Scenes At Process Street
QuekelsBaro
 
PDF
Becoming A User Advocate
Karl Kaufmann
 
PPTX
Make Your Contribution Count. Adding Value to the API as a Technical Communic...
Petko Mikhailov
 
How to embed UX thinking in API design
stephshin
 
Developers are People Too! Building a DX-Based API Strategy Ronnie Mitra, Pri...
CA API Management
 
02 API Academy - path to success
CHARLES Frédéric
 
UX Overview for Agile Engineering-Driven Organizations
Jim Jarrett
 
Considerations For an API Strategy - Ronnie MItra API Architect Layer 7 Londo...
CA API Management
 
User Experience Design, talk at the #bizathon
Kiran Subbaraman
 
UX is for Losers
Federico Pizzutto
 
Hacking UX: Product Design Thinking for Techies
Melissa Ng
 
Be My API How to Implement an API Strategy Everyone will Love
CA API Management
 
Bulletproofing Your APIs: Why Users’ Feedback Matters
Pronovix
 
Richard Marsh, Enterprising User Experience - Flex and the city
Richard Marsh
 
UserTesting 2016 webinar: Research to inform product design in Agile environm...
Steve Fadden
 
Building API Products
James Samuel
 
An Introduction to User Experience for Dev's & Techies
Scott Savage
 
Applying a Developer-Centric Approach to API Design from API Architect Ronnie...
CA API Management
 
Do's and Don'ts of APIs
Jason Harmon
 
On the shoulders of giants Learning About API Design by Looking Backwards
CA API Management
 
UX Research Methods: Behind the Scenes At Process Street
QuekelsBaro
 
Becoming A User Advocate
Karl Kaufmann
 
Make Your Contribution Count. Adding Value to the API as a Technical Communic...
Petko Mikhailov
 
Ad

More from Pronovix (20)

PDF
By the time they're reading the docs, it's already too late
Pronovix
 
PPTX
Optimizing Dev Portals with Analytics and Feedback
Pronovix
 
PPTX
Success metrics when launching your first developer portal
Pronovix
 
PDF
Documentation, APIs & AI
Pronovix
 
PDF
Making sense of analytics for documentation pages
Pronovix
 
PPTX
Feedback cycles and their role in improving overall developer experiences
Pronovix
 
PDF
GraphQL Isn't An Excuse To Stop Writing Docs
Pronovix
 
PPTX
API Documentation For Web3
Pronovix
 
PDF
Why your API doesn’t solve my problem: A use case-driven API design
Pronovix
 
PDF
unREST among the docs
Pronovix
 
PDF
Developing a best-in-class deprecation policy for your APIs
Pronovix
 
PDF
Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone
Pronovix
 
PDF
What do developers do when it comes to understanding and using APIs?
Pronovix
 
PDF
Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations
Pronovix
 
PDF
Creating API documentation for international communities
Pronovix
 
PDF
One Developer Portal to Document Them All
Pronovix
 
PDF
Docs-as-Code: Evolving the API Documentation Experience
Pronovix
 
PDF
Developer journey - make it easy for devs to love your product
Pronovix
 
PPTX
Complexity is not complicatedness
Pronovix
 
PDF
How cognitive biases and ranking can foster an ineffective architecture and d...
Pronovix
 
By the time they're reading the docs, it's already too late
Pronovix
 
Optimizing Dev Portals with Analytics and Feedback
Pronovix
 
Success metrics when launching your first developer portal
Pronovix
 
Documentation, APIs & AI
Pronovix
 
Making sense of analytics for documentation pages
Pronovix
 
Feedback cycles and their role in improving overall developer experiences
Pronovix
 
GraphQL Isn't An Excuse To Stop Writing Docs
Pronovix
 
API Documentation For Web3
Pronovix
 
Why your API doesn’t solve my problem: A use case-driven API design
Pronovix
 
unREST among the docs
Pronovix
 
Developing a best-in-class deprecation policy for your APIs
Pronovix
 
Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone
Pronovix
 
What do developers do when it comes to understanding and using APIs?
Pronovix
 
Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations
Pronovix
 
Creating API documentation for international communities
Pronovix
 
One Developer Portal to Document Them All
Pronovix
 
Docs-as-Code: Evolving the API Documentation Experience
Pronovix
 
Developer journey - make it easy for devs to love your product
Pronovix
 
Complexity is not complicatedness
Pronovix
 
How cognitive biases and ranking can foster an ineffective architecture and d...
Pronovix
 
Ad

Recently uploaded (20)

PPTX
Future Tech Innovations 2025 – A TechLists Insight
TechLists
 
PPTX
Agentforce World Tour Toronto '25 - MCP with MuleSoft
Alexandra N. Martinez
 
PDF
AI Agents in the Cloud: The Rise of Agentic Cloud Architecture
Lilly Gracia
 
PPTX
Mastering ODC + Okta Configuration - Chennai OSUG
HathiMaryA
 
PDF
Peak of Data & AI Encore AI-Enhanced Workflows for the Real World
Safe Software
 
PDF
UPDF - AI PDF Editor & Converter Key Features
DealFuel
 
PDF
Agentic AI lifecycle for Enterprise Hyper-Automation
Debmalya Biswas
 
PDF
NASA A Researcher’s Guide to International Space Station : Physical Sciences ...
Dr. PANKAJ DHUSSA
 
PDF
Staying Human in a Machine- Accelerated World
Catalin Jora
 
PDF
[Newgen] NewgenONE Marvin Brochure 1.pdf
darshakparmar
 
PDF
Transforming Utility Networks: Large-scale Data Migrations with FME
Safe Software
 
PDF
NLJUG Speaker academy 2025 - first session
Bert Jan Schrijver
 
PPTX
MuleSoft MCP Support (Model Context Protocol) and Use Case Demo
shyamraj55
 
PPTX
Agentforce World Tour Toronto '25 - Supercharge MuleSoft Development with Mod...
Alexandra N. Martinez
 
PDF
“Computer Vision at Sea: Automated Fish Tracking for Sustainable Fishing,” a ...
Edge AI and Vision Alliance
 
PPTX
COMPARISON OF RASTER ANALYSIS TOOLS OF QGIS AND ARCGIS
Sharanya Sarkar
 
PDF
Bitcoin for Millennials podcast with Bram, Power Laws of Bitcoin
Stephen Perrenod
 
PPTX
Digital Circuits, important subject in CS
contactparinay1
 
DOCX
Python coding for beginners !! Start now!#
Rajni Bhardwaj Grover
 
PPTX
Seamless Tech Experiences Showcasing Cross-Platform App Design.pptx
presentifyai
 
Future Tech Innovations 2025 – A TechLists Insight
TechLists
 
Agentforce World Tour Toronto '25 - MCP with MuleSoft
Alexandra N. Martinez
 
AI Agents in the Cloud: The Rise of Agentic Cloud Architecture
Lilly Gracia
 
Mastering ODC + Okta Configuration - Chennai OSUG
HathiMaryA
 
Peak of Data & AI Encore AI-Enhanced Workflows for the Real World
Safe Software
 
UPDF - AI PDF Editor & Converter Key Features
DealFuel
 
Agentic AI lifecycle for Enterprise Hyper-Automation
Debmalya Biswas
 
NASA A Researcher’s Guide to International Space Station : Physical Sciences ...
Dr. PANKAJ DHUSSA
 
Staying Human in a Machine- Accelerated World
Catalin Jora
 
[Newgen] NewgenONE Marvin Brochure 1.pdf
darshakparmar
 
Transforming Utility Networks: Large-scale Data Migrations with FME
Safe Software
 
NLJUG Speaker academy 2025 - first session
Bert Jan Schrijver
 
MuleSoft MCP Support (Model Context Protocol) and Use Case Demo
shyamraj55
 
Agentforce World Tour Toronto '25 - Supercharge MuleSoft Development with Mod...
Alexandra N. Martinez
 
“Computer Vision at Sea: Automated Fish Tracking for Sustainable Fishing,” a ...
Edge AI and Vision Alliance
 
COMPARISON OF RASTER ANALYSIS TOOLS OF QGIS AND ARCGIS
Sharanya Sarkar
 
Bitcoin for Millennials podcast with Bram, Power Laws of Bitcoin
Stephen Perrenod
 
Digital Circuits, important subject in CS
contactparinay1
 
Python coding for beginners !! Start now!#
Rajni Bhardwaj Grover
 
Seamless Tech Experiences Showcasing Cross-Platform App Design.pptx
presentifyai
 

How to Embed UX Thinking in Your Next API

  • 1. Steph Shin UX thinking in API design
  • 2. ● Cross-functional teams ● Organized problem spaces not discipline ● Platform product line ● App store billing domain ● Highly technical space Context: UX designer at Shopify
  • 3. ● Serves third party app developers ● Allows app developers to charge Shopify Merchants directly through their store account ● Originally built in REST ● Our goal was to build it in GraphQL ● Launch at Shopify Unite 2019 Context: Shopify’s Billing API
  • 5. “Instead of defining the structure of responses on the server, the flexibility is given to the client.” – Petr Bela, GraphQL in the age of REST APIs
  • 6. REST vs. GraphQL Source: https://medium.com/chute-engineering/graphql-in-the-age-of-rest-apis-b10f2bf09bba
  • 7. Why would I need to think about UX for an API?
  • 10. “An API is first & foremost an interface for people” – Arnaud Lauret, The Design of Web APIs
  • 12. if API = Interface and Developer = user then using API = UX
  • 13. Start by accepting the fact that you are NOT the user!
  • 14. “[Users] are usually very different than those who write the code, even [when] they are developers: they have different backgrounds, experiences with user interfaces, mindsets, mental models, and goals. They are not us.” – Raluca Budiu, You Are Not the User: The False-Consensus Effect
  • 15. ● Trustworthy & consistent (even if it’s unpredictable) ● Human (even if it’s highly technical) ● Discoverable (even if it’s not the main star) ● Easy & simple (even if it’s challenging & complex) Great UX should feel...
  • 16. “Good design, when it’s done well, becomes invisible. It’s only when it’s done poorly that we notice it.” – Jared Spool
  • 17. ● Who will be using this API? ● What problem does this solve? ● What are the use cases? ● What could get in the way of an enjoyable experience? ● How do users understand the problem space? Helpful questions to guide the design of great user experiences:
  • 18. What does UX look like for API’s?
  • 19. Collaborate Be open to the wealth of insights and ideas that non-technical people bring to the technical design process. NOTE: Discussions can be difficult because words often hold many different definitions. Diagrams, models or a glossary could help ensure better alignment.
  • 20. “Teams that fail, fail to listen to each other.” – Brent Summers, Get over yourself: Collaboration is the secret to great products
  • 21. Research precedents Look to related or similar examples to understand the thinking behind the solution. Try to piece together what they learned that led to their decisions. NOTE: It’s not enough to simply copy. You’ll need to understand how to apply it to your specific context.
  • 23. Interview users Talk to users directly and learn about their current solutions, their motivations and their mental models. NOTE: It’s very easy to fall into biases. Be sure to work with a researcher whenever possible to avoid influencing interviewees with leading questions.
  • 24. Example of a leading question: “I saw you were having difficulty with the navigation. What happened?” Vs. “What was easy or difficult about getting to the content you wanted?” ⛔ ��
  • 25. “Leading questions rob us of the opportunity to hear an insight we weren’t expecting.” – Amy Schade, Avoid Leading Questions to Get Better Insights from Participants
  • 26. Model the concept Map out and visualize the objects & relationships involved. Use this to align on the system, taxonomy and schema. NOTE: Focus on organizing the objects and articulating how they relate to each other and move through the system. It’s helpful to think of journeys. Use analogies to help you illustrate the concepts.
  • 29. Test out the usability Whether hi- or lo-definition, find a way to present and test the core logic and structures of the API design. This can be done with, interviews, tree tests, surveys... NOTE: Be as objective as possible and work with a researcher when possible to avoid influencing your bias.
  • 33. Steps to improve user experience Collaborate Research precedents Interview users Model the concept Test out the usability
  • 34. What did I learn?
  • 35. Naming is hard! Language has many layers of meaning steeped in culture, past experiences and individual biases. Focus on the what the word represents rather than the specific words and finalize the terminology later.
  • 36. Oversimplification can complicate things Taking a complex concept and oversimplifying it can cause problems when scaling. Try to avoid conflating similar but separate concepts.
  • 38. Usage fees in GraphQL
  • 39. Not all feedback is equal Find a balance between being descriptive and prescriptive. You don’t have to act on every feedback. Decisions should be informed by the product vision as well as user feedback and data.