# Consumer Requirements & Onboarding

Canonical page: https://apiopscycles.com/stations/api-consumer-experience

Language: en

Entity ID: api-consumer-experience

## Description

Capture integration consumer and provider requirements, onboarding needs, service expectations, data quality, support, and recovery requirements.

## Why it matters

The right architecture depends on consumer goals, onboarding expectations, service levels, data quality needs, change tolerance, observability, support, and producer constraints.

## Apply in work

Use consumer experience and onboarding guidance to make expectations explicit for both consumers and producers.

## Outcomes

- Documented consumer requirements and onboarding expectations
- Clear producer responsibilities and support expectations
- Architecture-relevant constraints ready for decision making
- Improved adoption through consumer empathy, standards, and producer clarity

## Steps

1. Identify consumer systems and teams, provider responsibilities, interaction needs, data needs, onboarding, and access expectations.
2. Define environments, test access, credentials, identity, compatibility, versioning, and service expectations.
3. Capture data quality, observability, support, failure handling, replay, reconciliation, and recovery needs.

## Questions

- Identify consumer systems and teams, provider responsibilities, interaction needs, data needs, onboarding, and access expectations.
- Define environments, test access, credentials, identity, compatibility, versioning, and service expectations.
- Capture data quality, observability, support, failure handling, replay, reconciliation, and recovery needs.
- Use consumer experience and onboarding guidance to make expectations explicit for both consumers and producers.
- The right architecture depends on consumer goals, onboarding expectations, service levels, data quality needs, change tolerance, observability, support, and producer constraints.

## Evidence

- design-artifact
- documentation
- consumer-feedback

## Completion criteria

- Capability opportunity is identified and documented. — Individual API opportunities are identified and documented. (ID: api-opportunity-documented)
- The capability addresses a clear business need and is reusable by its intended consumers. — The API meets a clear business need and is reusable for multiple API consumers. (ID: api-reusability)
- The selected interface provides an appropriate abstraction for consumers. — The API is intended to shield consumers from backend complexity and inconsistencies. (ID: hide-backend-discrepancies)
- The capability value proposition has been validated with business and consumer stakeholders. — The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders. (ID: value-prop-validated)
- Consumer segments are identified. — API consumer segments (internal and external) are identified. (ID: consumer-segments-identified)
- A high-level implementation roadmap is defined. — High-level roadmaps for API development are established. (ID: api-roadmap-defined)

## Role participation and responsibilities

- [API Consumer Representative](https://apiopscycles.com/roles/api-consumer-specialist.md) (lead): Represents the needs of developers, integrators, or other API consumers who use the API directly.; suggested-answer-owner: [Integration Consumer & Provider Commitments Canvas](https://apiopscycles.com/resources/integration-consumer-provider-requirements-canvas.md)
- [API Product Owner](https://apiopscycles.com/roles/api-product-owner.md) (lead): Drives the API opportunity, prioritization, and product-level decisions across the lifecycle.
- [Customer or Partner Representative](https://apiopscycles.com/roles/customer-specialist.md) (lead): Contributes the business customer or partner perspective for the journey, value, and collaboration model.; suggested-answer-owner: [Capability Consumer & Producer Commitments Canvas](https://apiopscycles.com/resources/capability-consumer-producer-requirements-canvas.md)
- [Process Owner](https://apiopscycles.com/roles/process-owner.md) (lead): Owns the business process being automated, including objectives, rules, outcomes, and improvement priorities.
- [Automation Owner](https://apiopscycles.com/roles/automation-owner.md) (core): Owns automation goals, business value, priorities, controls, and lifecycle outcomes.
- [Capability Owner](https://apiopscycles.com/roles/capability-owner.md) (core): Owns the capability vision, value, priorities, lifecycle, and reuse across consumers.
- [Documentation and DevRel Owner](https://apiopscycles.com/roles/api-devrel-specialist.md) (core): Owns onboarding content, developer communication, and documentation quality for API consumers.
- [Domain Expert](https://apiopscycles.com/roles/domain-specialist.md) (core): Brings deep knowledge of the business domain, concepts, rules, and constraints the capability or interface must reflect.
- [Integration Architect](https://apiopscycles.com/roles/integration-architect.md) (core): Designs integration approaches and implementation styles that connect the capability or API with other systems.
- [Support and Operations Owner](https://apiopscycles.com/roles/operations-specialist.md) (core): Represents runtime support, incident handling, observability, and operational readiness for the capability, API, or automation.
- [API Designer](https://apiopscycles.com/roles/api-designer.md) (consulted): Shapes the interface contract, interaction model, consistency, and usability of the exposed capabilities.
- [Automation Engineer](https://apiopscycles.com/roles/automation-engineer.md) (consulted): Implements, tests, integrates, and maintains automation solutions and supporting workflows.
- [Business Owner](https://apiopscycles.com/roles/business-owner.md) (consulted): Represents business goals, funding, and expected outcomes for the capability, API, or automation initiative.
- [Compliance and Legal Specialist](https://apiopscycles.com/roles/compliance-specialist.md) (consulted): Clarifies legal, privacy, regulatory, and contractual requirements that affect the capability, API, interface, or automation.
- [Partner or Vendor Manager](https://apiopscycles.com/roles/partner-specialist.md) (consulted): Coordinates external partner, supplier, or vendor relationships that influence capability or API strategy and delivery.
- [Security Specialist](https://apiopscycles.com/roles/security-specialist.md) (consulted): Ensures security risks, controls, and trust boundaries are addressed throughout the API lifecycle.

## Cycle-specific guidance

- [Capability Productization Cycle](https://apiopscycles.com/cycles/capability-productization-cycle/stations/api-consumer-experience.md)
- [API Productization Cycle](https://apiopscycles.com/cycles/api-productization-cycle/stations/api-consumer-experience.md)
- [Integration Productization Cycle](https://apiopscycles.com/cycles/integration-productization-cycle/stations/api-consumer-experience.md)
- [Automation Cycle](https://apiopscycles.com/cycles/automation-cycle/stations/api-consumer-experience.md)