# Publicação da API — Ciclo de Produto de API Canonical page: https://apiopscycles.com/pt/cycles/api-productization-cycle/stations/api-publishing Language: pt Entity ID: api-publishing Cycle: [Ciclo de Produto de API](https://apiopscycles.com/pt/cycles/api-productization-cycle.md) Read [shared station guidance](https://apiopscycles.com/pt/stations/api-publishing.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 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) - 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) - A interface e as suas capacidades estão documentadas de forma suficientemente clara para revisão, auditoria e onboarding. — The API and its exposed capabilities are described clearly enough for review, audit, and onboarding. (ID: api-description-available) - 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) - O contrato de interface foi validado e testado face aos requisitos funcionais e não funcionais. — The API contract is tested and meets functional and non-functional requirements. (ID: api-contract-tested) ## Journey exit criteria - A solução passa as verificações de qualidade, segurança, conformidade e prontidão. — The API passes compliance, security, and audit checks. (ID: audit-passed) - As conclusões da auditoria e as decisões de correção são partilhadas com as partes interessadas relevantes. — Audit findings and remediation decisions are shared with the relevant stakeholders. (ID: audit-reports-shared) - A capacidade está pronta para ser publicada ou disponibilizada através do mecanismo de entrega selecionado. — The API is ready to be deployed and exposed through the intended gateways and environments. (ID: api-ready-for-publishing) - A documentação orientada para os utilizadores e os materiais de onboarding estão prontos. — Consumer-facing API documentation is complete enough for publishing and onboarding. (ID: api-documentation-ready) ## Description Exponha as APIs de forma segura e clara ao público certo com a documentação e os processos corretos. ## Why it matters A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz. ## Apply in work Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade. ## Outcomes - APIs publicadas no ambiente correto (privado, parceiro, público) - Processos claros de integração e registo da API - Documentação, modelos e políticas de segurança disponíveis - APIs prontas para escala e governação ## Steps 1. Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API. 2. Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo. 3. Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores. 4. Feedback e controlo: como serão monitorizados adoção, confiança, uso real, problemas e comportamento inesperado, e que condições acionam pausa, rollback ou retorno à operação manual? ## Questions - Publicar APIs nos gateways e ambientes adequados para apoiar a reutilização por vários consumidores de API. - Documentar a forma como os consumidores encontram e utilizam a API, incluindo processos de integração e registo. - Garantir que os modelos de segurança, a configuração da porta de ligação e os termos legais sejam claros e acessíveis aos consumidores. - Permitir que as APIs sejam publicadas no ambiente relevante e ter mecanismos claros de registo e acesso (por exemplo, chaves de API, OAuth, planos de subscrição), dependendo dos segmentos de consumidores de API e dos requisitos de segurança e conformidade. - A publicação é mais do que a disponibilização - trata-se de capacidade de descoberta, acesso e suporte. Se as APIs não forem publicadas corretamente, não serão utilizadas, reutilizadas ou protegidas de forma eficaz. ## Role participation and responsibilities - [Responsável pelo produto API](https://apiopscycles.com/pt/roles/api-product-owner.md) (lead): Conduz a oportunidade API, a priorização e as decisões ao nível do produto ao longo do ciclo de vida. - [Especialista em conformidade e jurídico](https://apiopscycles.com/pt/roles/compliance-specialist.md) (core): 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) (core): Garante que os riscos de segurança, controlos e fronteiras de confiança são tratados ao longo de todo o ciclo de vida. - [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. - [Responsável por documentação e DevRel](https://apiopscycles.com/pt/roles/api-devrel-specialist.md) (core): Responsável por conteúdos de onboarding, comunicação com programadores e qualidade da documentação para utilizadores da API. - [Responsável por suporte e operações](https://apiopscycles.com/pt/roles/operations-specialist.md) (core): Representa o suporte em execução, tratamento de incidentes, observabilidade e prontidão operacional da capacidade, API ou automatização. - [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. - [Responsável de negócio](https://apiopscycles.com/pt/roles/business-owner.md) (consulted): Representa os objetivos de negócio, o financiamento e os resultados esperados da iniciativa de capacidade, API ou automatização. ## Resources - [Lista de verificação de auditoria da API](https://apiopscycles.com/pt/resources/api-audit-checklist.md)