liveBook · Manning

Api value proposition canvas

As explained in Automating API Delivery

An API value proposition canvas is a structured analysis tool for relating an API consumer's pains and expected gains to an API product's value proposition.

An API value proposition canvas connects consumer jobs, pains, and desired gains with the API capabilities and internal resources intended to create value. Use it early in API design to align engineers, architects, product managers, business sponsors, and other stakeholders. section 5.2.3

Build the canvas from two profiles joined by a value statement:

  • Consumer profile: record the jobs the consumer must complete, the pains encountered, and the gains sought. section 5.2.3
  • Value map: identify data sources, internal APIs, applications, and processes that can relieve pains or create gains. section 5.2.3
  • Interface: state the value the API provides by explaining how its features address consumer pains and gains. section 5.2.3

Product Catalog API

A Product Catalog API helps customers discover pet products. Its job stories cover browsing by category and searching for products; search is deferred to phase 2. The API combines internal Products, Catalog, and Reviews microservices.

How Automating API Delivery covers it

How deep it goes
Defines two canvas sections and their interface, but leaves detailed requirements and scope to job stories and digital capabilities.
Examples
Uses a Product Catalog API, pet-product browsing and search job stories, and Products, Catalog, and Reviews microservices.
What you can do after
Apply it to align stakeholders on what an API should do and how its features address consumer pains and desired gains.
How it connects
Connects API design with job stories, digital capabilities, consumer profiles, internal APIs, and stakeholder review.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.