# Conceção da solução de integração — Ciclo de Produto de Integração

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

Language: pt

Entity ID: api-design

Cycle: [Ciclo de Produto de Integração](https://apiopscycles.com/pt/cycles/integration-productization-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

Desenhar a solução de integração, contratos, esquemas, estruturas de dados, mapeamentos e padrões de interação ou entrega para o estilo selecionado.

## Role participation and responsibilities

- [Arquiteto de integração](https://apiopscycles.com/pt/roles/integration-architect.md) (lead): Desenha abordagens de integração e estilos de implementação que ligam a capacidade ou API a outros sistemas.; suggested-answer-owner: [Canvas de desenho da solução de integração](https://apiopscycles.com/pt/resources/integration-solution-design-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.
- [Designer API](https://apiopscycles.com/pt/roles/api-designer.md) (core): Modela o contrato de interface, o modelo de interação, a consistência e a usabilidade das capacidades expostas.
- [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.
- [Representante dos utilizadores da API](https://apiopscycles.com/pt/roles/api-consumer-specialist.md) (core): Representa as necessidades de programadores, integradores ou outros utilizadores que utilizam a API diretamente.
- [Engenheiro de entrega](https://apiopscycles.com/pt/roles/api-engineer.md) (consulted): Responsável pela implementação, automatização, testes e fluxo de publicação necessários para entregar a capacidade, API ou automatização de forma fiável.
- [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 Interação](https://apiopscycles.com/pt/resources/interaction-canvas.md)
- [Canvas de Domínio](https://apiopscycles.com/pt/resources/domain-canvas.md)
- [Canvas de desenho da solução de integração](https://apiopscycles.com/pt/resources/integration-solution-design-canvas.md)