# Conceção do fluxo de trabalho de automação — Ciclo de Automação

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

Language: pt

Entity ID: api-design

Cycle: [Ciclo de Automação](https://apiopscycles.com/pt/cycles/automation-cycle.md)

Read [shared station guidance](https://apiopscycles.com/pt/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

- A capacidade responde a uma necessidade clara de negócio e é reutilizável pelos utilizadores previstos. — The API meets a clear business need and is reusable for multiple API consumers. (ID: api-reusability)
- A interface selecionada fornece uma abstração adequada aos utilizadores. — The API is intended to shield consumers from backend complexity and inconsistencies. (ID: hide-backend-discrepancies)
- A proposta de valor da capacidade foi validada com partes interessadas de negócio e utilizadores. — The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders. (ID: value-prop-validated)
- Os segmentos de utilizadores estão identificados. — API consumer segments (internal and external) are identified. (ID: consumer-segments-identified)
- Está definido um roadmap de implementação de alto nível. — High-level roadmaps for API development are established. (ID: api-roadmap-defined)

## Journey exit criteria

- A arquitetura, plataforma e estilo de implementação escolhidos foram validados com as partes interessadas relevantes de arquitetura, segurança e plataforma. — The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders. (ID: architecture-patterns-validated)
- A interface selecionada fornece uma abstração adequada aos utilizadores. — The API is intended to shield consumers from backend complexity and inconsistencies. (ID: hide-backend-discrepancies)
- O desenho da interface e as capacidades expostas são rastreáveis ao valor de negócio e às necessidades dos utilizadores. — The API design and exposed capabilities clearly trace back to business value and user needs. (ID: design-reflects-business-value)
- O desenho da interface segue os standards e convenções de desenho acordados. — The API design follows our shared API product and design conventions. (ID: api-consistency)

## Description

Desenhe o workflow interno necessário para entregar os resultados selecionados para o cliente e a capacidade, incluindo alocação de trabalho, controlos, exceções, recuperação, evidência e monitorização.

## Role participation and responsibilities

- [Engenheiro de automatização](https://apiopscycles.com/pt/roles/automation-engineer.md) (lead): Implementa, testa, integra e mantém soluções de automatização e workflows de suporte.; suggested-answer-owner: [Canvas de workflow de automação](https://apiopscycles.com/pt/resources/automation-workflow-canvas.md)
- [Arquiteto de plataforma](https://apiopscycles.com/pt/roles/platform-architect.md) (core): Orienta decisões de plataforma, integração, escalabilidade e arquitetura que moldam como a capacidade ou API é construída e operada.
- [Especialista de domínio](https://apiopscycles.com/pt/roles/domain-specialist.md) (core): Traz conhecimento profundo do domínio de negócio, conceitos, regras e restrições que a capacidade ou interface deve refletir.
- [Responsável pela automatização](https://apiopscycles.com/pt/roles/automation-owner.md) (core): Responsável pelos objetivos, valor de negócio, prioridades, controlos e resultados do ciclo de vida da automatização.
- [Responsável pelo processo](https://apiopscycles.com/pt/roles/process-owner.md) (core): Responsável pelo processo de negócio a automatizar, incluindo objetivos, regras, resultados e prioridades de melhoria.
- [Arquiteto de integração](https://apiopscycles.com/pt/roles/integration-architect.md) (consulted): Desenha abordagens de integração e estilos de implementação que ligam a capacidade ou API a outros sistemas.
- [Especialista em conformidade e jurídico](https://apiopscycles.com/pt/roles/compliance-specialist.md) (consulted): Esclarece requisitos legais, de privacidade, regulamentares e contratuais que afetam a capacidade, API, interface ou automatização.
- [Especialista em segurança](https://apiopscycles.com/pt/roles/security-specialist.md) (consulted): Garante que os riscos de segurança, controlos e fronteiras de confiança são tratados ao longo de todo o ciclo de vida.

## Resources

- [Canvas de workflow de automação](https://apiopscycles.com/pt/resources/automation-workflow-canvas.md)