# Automation Workflow Design — Automation Cycle

Canonical page: https://apiopscycles.com/cycles/automation-cycle/stations/api-design

Language: en

Entity ID: api-design

Cycle: [Automation Cycle](https://apiopscycles.com/cycles/automation-cycle.md)

Read [shared station guidance](https://apiopscycles.com/stations/api-design.md) first. The sections below supplement or replace the corresponding shared sections for this cycle. Sections not repeated here retain the shared guidance.

## Journey entry criteria

- 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)

## Journey exit criteria

- The chosen architecture, platform, and implementation style have been validated with the relevant architecture, security, and platform stakeholders. — The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders. (ID: architecture-patterns-validated)
- 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 interface design and exposed capabilities trace back to business value and consumer needs. — The API design and exposed capabilities clearly trace back to business value and user needs. (ID: design-reflects-business-value)
- The interface design follows agreed design standards and conventions. — The API design follows our shared API product and design conventions. (ID: api-consistency)

## Description

Design the internal workflow needed to deliver the selected customer and capability outcomes, including work allocation, controls, exceptions, recovery, evidence, and monitoring.

## Role participation and responsibilities

- [Automation Engineer](https://apiopscycles.com/roles/automation-engineer.md) (lead): Implements, tests, integrates, and maintains automation solutions and supporting workflows.; suggested-answer-owner: [Automation Workflow Canvas](https://apiopscycles.com/resources/automation-workflow-canvas.md)
- [Automation Owner](https://apiopscycles.com/roles/automation-owner.md) (core): Owns automation goals, business value, priorities, controls, and lifecycle outcomes.
- [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.
- [Platform Architect](https://apiopscycles.com/roles/platform-architect.md) (core): Guides platform, integration, scalability, and architecture decisions that shape how the capability or API is built and operated.
- [Process Owner](https://apiopscycles.com/roles/process-owner.md) (core): Owns the business process being automated, including objectives, rules, outcomes, and improvement priorities.
- [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.
- [Integration Architect](https://apiopscycles.com/roles/integration-architect.md) (consulted): Designs integration approaches and implementation styles that connect the capability or API with other systems.
- [Security Specialist](https://apiopscycles.com/roles/security-specialist.md) (consulted): Ensures security risks, controls, and trust boundaries are addressed throughout the API lifecycle.

## Resources

- [Automation Workflow Canvas](https://apiopscycles.com/resources/automation-workflow-canvas.md)
