Um ciclo para transformar capacidades de integracao reutilizaveis em produto antes de selecionar o estilo de implementacao.
Orientar a concecao de capacidades de integracao reutilizaveis antes de escolher um estilo de implementacao API, evento, ficheiro, stream, produto de dados, integracao direta ou hibrido.
Sua rota no mapa
Mapa do metrô
Select a cycle, station, or stakeholder to open its permanent method page.
Selected station: Estratégia de produtos API - Transforme APIs em produtos estratégicos
Pessoas a envolver
Resources and canvases
Critérios do percurso
Critérios de entrada
Os objetivos de negócio estão definidos.
A oportunidade de capacidade está identificada e documentada.
Critérios de saída
A arquitetura, plataforma e estilo de implementação escolhidos foram validados com as partes interessadas relevantes de arquitetura, segurança e plataforma.
A interface e as suas capacidades estão documentadas de forma suficientemente clara para revisão, auditoria e onboarding.
A solução passa as verificações de qualidade, segurança, conformidade e prontidão.
Enquadrar a capacidade de integracao reutilizavel, a necessidade de negocio, o ownership e a reutilizacao esperada antes de selecionar o estilo de implementacao.
Muitas organizações pensam nas APIs como projetos tecnológicos e não como produtos. O resultado? Consumidores confusos, fraca adoção e esforço desperdiçado.
Esta estação ajuda-o a definir o objetivo da sua API, o público-alvo e os critérios de sucesso, para que as equipas possam fornecer APIs que resolvam problemas reais.
Recolha consumidores da integração, responsabilidades dos fornecedores, necessidades de integração, expectativas de serviço e restrições operacionais.
As APIs excelentes não funcionam apenas - elas são intuitivas. Quer o consumidor seja um programador interno, um parceiro externo ou um agente de IA, a sua experiência determina a adoção.
Snum plano de experiência claro:
- Grandes APIs ficam sem uso
- As equipas perdem tempo a tentar adivinhar como utilizar a sua API
- Os ciclos de feedback estão quebrados ou ausentes.
Esta estação ajuda-o a ver a sua API através dos olhos dos seus consumidores.
Selecionar a arquitetura de integracao, o estilo de implementacao e as capacidades de plataforma, tendo em conta as restricoes e o modelo de governacao.
Quando as APIs são escalonadas entre equipas, a sua plataforma deve permitir a governação e a reutilização sem bloquear a velocidade. Esta estação mostra como arquitetar APIs para longevidade, segurança e eficiência.
Conceber o contrato de interface, os esquemas, os payloads e os padroes de interacao para o estilo de integracao selecionado.
Conceber APIs não se resume apenas a nomear endpoints. Um bom projeto garante que as APIs sejam utilizáveis, consistentes e alinhadas com os objetivos de negócio e técnicos. Um projeto inadequado leva a um acoplamento rígido, baixa reutilização e retrabalho dispendioso entre as equipas.
Construir, testar, automatizar, disponibilizar e operar a capacidade de integracao usando o estilo de implementacao selecionado e o contrato de interface validado.
Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.
Assegure a prontidão, a governação, a qualidade, a segurança, a conformidade e as evidências operacionais da integração antes da disponibilização.
As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.
Publicar a capacidade de integracao para que as equipas a possam descobrir, avaliar, solicitar acesso, concluir o onboarding, reutiliza-la e obter suporte.
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.
Monitorize a fiabilidade da integração, a reutilização, os incidentes, o desempenho, os resultados dos consumidores e as necessidades de melhoria.
A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.
Publish this cycle
Export the page-specific template after reviewing the entity summary and supporting details above.
Exportação Confluence
Modelos de publicação
Use Markdown for repositories and static sites, or Confluence-wiki markup for compatible Confluence pages.
Markdown
# Ciclo de Produto de Integração question template
Um ciclo para transformar capacidades de integracao reutilizaveis em produto antes de selecionar o estilo de implementacao.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
## 1. Estratégia da capacidade de integração
Enquadrar a capacidade de integracao reutilizavel, a necessidade de negocio, o ownership e a reutilizacao esperada antes de selecionar o estilo de implementacao.
### Canvas questions
#### Canvas do Percurso do Cliente
Qual é a percurso do cliente ou parceiro que a API pretende apoiar?
- **Persona**: Quem é o cliente típico que passa por esta percurso?
- **O cliente descobre a necessidade**: Como o cliente reconhece sua necessidade ou problema?
- **Necessidade do cliente resolvida**: Como a necessidade do cliente é resolvida no final?
- **Etapas da percurso**: Quais são as etapas que o cliente percorre em sua percurso?
- **Dores**: Quais são os pontos fracos ou desafios do cliente?
- **Ganhos**: Quais são os ganhos ou benefícios do cliente?
- **Entradas e saídas**: Quais são as entradas e saídas em cada etapa?
- **Regras de interação e processamento**: Quais são as regras de interação e processamento em cada etapa?
#### Canvas de Domínio
Quais são as entidades principais e as regras de negócio relacionadas com a API?
- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?
- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?
- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?
- **Relações entre entidades**: Quais são as relações entre as entidades?
- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?
- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?
#### Canvas da Proposta de Valor da Capacidade
Que capacidade reutilizável criaria valor para os utilizadores sem decidir ainda se deve ser disponibilizada como API, evento, ficheiro, stream, produto de dados ou outro estilo de implementação?
- **Tarefas e resultados dos utilizadores**: O que os utilizadores, parceiros, utilizadores, sistemas ou equipas estão a tentar alcançar?
- **Funcionalidades da capacidade que permitem ganhos**: Que funcionalidades da capacidade ajudariam os utilizadores a alcançar melhores resultados, rapidez, automação, conhecimento, alcance ou conformidade?
- **Funcionalidades da capacidade que aliviam dores**: Que funcionalidades da capacidade removeriam atrito, trabalho manual, erros, atrasos, risco ou incerteza para os utilizadores?
- **Capacidades reutilizáveis**: Que capacidades de negócio ou de dados reutilizáveis poderiam servir estas tarefas, ganhos e dores em mais do que um utilizador ou caso de utilização?
#### Canvas do Modelo de Negócio da Capacidade
Quão viável, reutilizável, financiada, atribuída, apoiada e detetável deve ser esta capacidade de integração?
- **Proposta de valor da capacidade**: Que valor esta capacidade reutilizável oferece aos utilizadores e à organização ou ecossistema?
- **Segmentos de utilizadores da capacidade**: Quem são os utilizadores atuais e potenciais da capacidade, incluindo equipas, parceiros, sistemas, produtos ou utilizadores de dados?
- **Envolvimento dos utilizadores**: Como irão os utilizadores descobrir, avaliar, solicitar, integrar-se, obter apoio e dar feedback sobre a capacidade?
- **Canais**: Através de que catálogos, portais, marketplaces, sites de documentação, caminhos de apoio ou processos de governação os utilizadores irão interagir com a capacidade?
- **Recursos-chave**: Que sistemas, ativos de dados, plataformas, pessoas, normas, financiamento e capacidades operacionais são necessários?
- **Atividades-chave**: O que o responsável pela capacidade e os produtores devem fazer para conceber, entregar, governar, apoiar e melhorar a capacidade?
- **Parceiros-chave**: Que parceiros de negócio, tecnologia, dados, segurança, jurídico, plataforma ou externos são necessários para que a capacidade funcione?
- **Benefícios**: Que benefícios de negócio, operacionais, de ecossistema, reutilização, conformidade ou custo justificam a capacidade?
- **Custos**: Quais são os custos significativos de construir, operar, governar, apoiar e evoluir a capacidade?
## 2. Requisitos e integração de consumidores da integração
Recolha consumidores da integração, responsabilidades dos fornecedores, necessidades de integração, expectativas de serviço e restrições operacionais.
### Canvas questions
#### Canvas de Requisitos da Experiência do Utilizador
Que requisitos de experiência e requisitos não funcionais os utilizadores precisam /de esclarecer antes de decidir a melhor arquitetura de integração?
- **Objetivos dos utilizadores**: Quais são os objetivos de negócio, de fluxo de trabalho, de decisão, de automação ou de utilização de dados dos utilizadores?
- **Disponibilidade e atualidade**: Quando é que a capacidade deve estar disponível, quão atualizada deve estar a informação e que latência ou janelas de entrega importam?
- **Volume e desempenho**: Que volumes de pedidos, eventos, registos, ficheiros, lotes, utilizadores ou transações a capacidade deve suportar agora e no futuro?
- **Qualidade e consistência dos dados**: Que expectativas de exatidão, completude, consistência, ordenação, deduplicação, reconciliação ou validação têm os utilizadores?
- **Segurança, privacidade e conformidade**: Que restrições de identidade, autorização, confidencialidade, residência, consentimento, retenção, auditoria ou regulamentação se aplicam?
- **Integração e acesso**: Como devem os utilizadores encontrar, solicitar, testar, obter aprovação e começar a utilizar a capacidade?
- **Mudança e controlo de versões**: Que tolerância à mudança têm os utilizadores e que expectativas de aviso prévio, compatibilidade, migração ou controlo de versões se aplicam?
- **Observabilidade e apoio**: Que monitorização, estado, rastreabilidade, visibilidade da qualidade dos dados, apoio, propriedade e comunicação de incidentes os utilizadores precisam?
- **Recuperação e continuidade**: Que expectativas de repetição, nova tentativa, reconciliação, cópia de segurança, fallback, continuidade ou recuperação manual devem ser suportadas?
- **Implicações de arquitetura**: O que estes requisitos implicam para possíveis estilos de arquitetura, como APIs, eventos, ficheiros, streams, produtos de dados ou integração direta?
### Other related resources
- **Boas práticas de integração de API**: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.
## 3. Arquitetura de integracao e decisoes de plataforma
Selecionar a arquitetura de integracao, o estilo de implementacao e as capacidades de plataforma, tendo em conta as restricoes e o modelo de governacao.
### Canvas questions
#### Canvas de Impacto no Negócio
Quais são os possíveis impactos no negócio da falha da API?
- **Riscos de disponibilidade**: Quais são os riscos potenciais para a disponibilidade da API?
- **Mitigar riscos de disponibilidade**: Como o fornecedor da API pode mitigar os riscos de disponibilidade?
- **Riscos de segurança**: Quais são os riscos potenciais de segurança associados à API?
- **Mitigar riscos de segurança**: Como o fornecedor da API pode mitigar os riscos de segurança?
- **Riscos de dados**: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?
- **Mitigar riscos de dados**: Como o fornecedor da API pode mitigar os riscos de dados?
#### Canvas de Localização
Que fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?
- **Grupos de Localização / Confiança**: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?
- **Características do grupo**: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?
- **Locais / Zonas Relevantes**: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?
- **Características de localização / zona**: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?
- **Distâncias de Rede / Regulatórias**: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?
- **Características da Distância**: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?
- **Pontos de extremidade de conectividade**: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?
- **Características de acesso aos pontos de extremidade**: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?
#### Canvas de Capacidade
Quanta capacidade é necessária para suportar o consumo da API?
- **Volumes de negócio atuais**: Quais são os volumes de negócio e as taxas de transação atuais?
- **Tendências de consumo futuro**: Quais são as tendências de consumo futuro previstas?
- **Requisitos de pico de carga e disponibilidade**: Quais são os requisitos de pico de carga e disponibilidade?
- **Estratégias de cache**: Quais estratégias de cache podem ser usadas para otimizar o desempenho?
- **Estratégias de limitação de pedidos**: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?
- **Estratégias de dimensionamento**: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?
### Other related resources
- **Diretrizes de integração de parceiros**: Listas de verificação de integração e padrões de comunicação para gerir os aspectos técnicos e legais das relações com APIs de terceiros.
## 4. Conceção da solução de integração
Conceber o contrato de interface, os esquemas, os payloads e os padroes de interacao para o estilo de integracao selecionado.
### Canvas questions
#### Canvas de Domínio
Quais são as entidades principais e as regras de negócio relacionadas com a API?
- **Etapas selecionadas da percurso do cliente**: Quais etapas da percurso do cliente são relevantes para este domínio?
- **Entidades principais e significado de negócio**: Quais são as entidades principais e seu significado de negócio?
- **Atributos e importância de negócio**: Quais são os principais atributos de cada entidade e sua importância de negócio?
- **Relações entre entidades**: Quais são as relações entre as entidades?
- **Regras de negócio, conformidade e integridade**: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?
- **Considerações sobre segurança e privacidade**: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?
#### Canvas de Interação
Que tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?
- **Interações CRUD**: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?
- **Modelos de entrada e saída CRUD**: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?
- **Processamento e validação CRUD**: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?
- **Interações orientadas por consulta**: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?
- **Modelos de entrada e saída orientados por consulta**: Quais são os modelos de entrada e saída para as interações orientadas por consulta?
- **Processamento e validação orientados por consulta**: Quais são as regras de processamento e validação para as interações orientadas por consulta?
- **Interações orientadas por comando**: Quais comandos de alteração de estado são necessários, se houver?
- **Modelos de entrada e saída orientados por comando**: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?
- **Processamento e validação orientados por comando**: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?
- **Interações orientadas por eventos**: Quais eventos precisam /de ser publicados ou consumidos, se houver?
- **Modelos de entrada e saída orientados por eventos**: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?
- **Processamento e validação orientados por eventos**: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?
#### Canvas REST
Como a API pode ser concebida utilizando os princípios RESTful?
- **Recursos da API**: Quais são os principais recursos expostos pela API?
- **Modelo de recurso da API**: Qual é a estrutura do modelo de recurso da API?
- **Verbos da API**: Quais verbos HTTP são usados para interagir com os recursos da API?
- **Exemplo de verbo da API**: Forneça um exemplo de pedido e resposta da API para cada verbo.
#### Canvas de Eventos
Quais eventos são relevantes para a API e como são processados?
- **Tarefa do utilizador/gatilho**: Que ação do utilizador ou evento do sistema aciona esta operação de evento?
- **Entrada / Carga útil do evento**: Que dados estão incluídos na carga útil do evento recebido? Especifique os atributos principais.
- **Processamento/Lógica**: Descreva a lógica de processamento de back-end, incluindo validações, transformações ou decisões de encaminhamento.
- **Saída/Resultado do evento**: Que evento ou confirmação resultante é produzido? Inclua atributos da carga útil de saída.
#### Canvas GraphQL
Como a API pode ser concebida utilizando os princípios do GraphQL?
- **Nome da API**: Qual é o nome da API GraphQL ou do endpoint?
- **Objetivos do utilizador**: Que problemas os utilizadores da API estão a tentar resolver? De que dados precisam?
- **Tipos de chave**: Quais são os tipos principais expostos (por exemplo, Utilizador, Pedido, Produto)?
- **Relações**: Como os tipos se relacionam entre si em consultas aninhadas?
- **Consultas**: Quais consultas comuns devem ser suportadas?
- **Mutações**: Quais operações modificarão os dados (por exemplo, criar, atualizar, eliminar)?
- **Assinaturas**: Existem atualizações em tempo real ou eventos que os utilizadores podem assinar?
- **Regras de autorização**: Quem pode aceder quais campos ou tipos?
- **Restrições do utilizador**: Existem restrições de paginação, filtragem ou limitação de pedidos?
- **Notas/Questões em aberto**: Alguma decisão pendente ou considerações sobre integração?
### Other related resources
- **Guia de seleção do estilo de implementação**: Orientação para escolher entre API, evento, ficheiro, stream, produto de dados, integração direta ou estilos de implementação híbridos com base nos requisitos e restrições.
- **Primeira conceção do contrato**: Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.
## 5. Entrega e operações da integração
Construir, testar, automatizar, disponibilizar e operar a capacidade de integracao usando o estilo de implementacao selecionado e o contrato de interface validado.
### Station questions
- Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável.
- Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos.
- Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas.
- Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.
- Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.
- Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
- Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da disponibilização.
- Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.
### Other related resources
- **Boas práticas de desenvolvimento de API**: Orientações de implementação para transformar um contrato de interface da API validado numa base de código de API consistente e sustentável, utilizando bibliotecas padrão, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.
- **Boas práticas de teste de API**: Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.
- **APIOps CI/CD para APIs**: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.
- **Boas práticas de segurança da API**: Um conjunto de controlos acionáveis para proteger APIs, incluindo autenticação, autorização, encriptação, limitação de taxas e verificações de conformidade ao nível do pipeline.
- **Diretrizes de integração de parceiros**: Listas de verificação de integração e padrões de comunicação para gerir os aspectos técnicos e legais das relações com APIs de terceiros.
## 6. Garantia de prontidão da integração
Assegure a prontidão, a governação, a qualidade, a segurança, a conformidade e as evidências operacionais da integração antes da disponibilização.
### Station questions
- Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação.
- Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.
- Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas para produção.
- Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.
- As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.
### Other related resources
- **Lista de verificação de auditoria da API**: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.
- **Boas práticas de conformidade da API**: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.
## 7. Publicacao e enablement da integracao
Publicar a capacidade de integracao para que as equipas a possam descobrir, avaliar, solicitar acesso, concluir o onboarding, reutiliza-la e obter suporte.
### Station 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.
### Other related resources
- **Boas práticas de integração de API**: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.
- **Modelo de contrato de serviço**: Um formato de acordo personalizável que define expectativas, SLAs, responsabilidades e termos de acesso para o consumo de API.
## 8. Monitorização e melhoria da integração
Monitorize a fiabilidade da integração, a reutilização, os incidentes, o desempenho, os resultados dos consumidores e as necessidades de melhoria.
### Station questions
- Monitorizar as métricas de desempenho (por exemplo, chamadas APIs, latência, taxas de erro) e as métricas de adoção (por exemplo, NPS).
- Analisar as métricas de utilização da API e incorporar o feedback dos utilizadores nas iterações da API.
- Crie o hábito de analisar os indicadores e planear actividades de melhoria contínua.
- Criar quadros analíticos para acompanhar o desempenho e o envolvimento. Desenvolver ciclos de feedback, ferramentas de análise e estratégias de envolvimento para APIs.
- A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.
### Other related resources
- **Métricas e análise de API**: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.
- **Estratégias de envolvimento da comunidade API**: Um manual para promover a adoção de APIs, cultivando comunidades através de conteúdos, canais de apoio, ciclos de feedback e estratégias de envolvimento social.
Confluence-wiki
h1. Ciclo de Produto de Integração question template
Um ciclo para transformar capacidades de integracao reutilizaveis em produto antes de selecionar o estilo de implementacao.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
h2. 1. Estratégia da capacidade de integração
Enquadrar a capacidade de integracao reutilizavel, a necessidade de negocio, o ownership e a reutilizacao esperada antes de selecionar o estilo de implementacao.
h3. Canvas questions
#### Canvas do Percurso do Cliente
Qual é a percurso do cliente ou parceiro que a API pretende apoiar?
* *Persona*: Quem é o cliente típico que passa por esta percurso?
* *O cliente descobre a necessidade*: Como o cliente reconhece sua necessidade ou problema?
* *Necessidade do cliente resolvida*: Como a necessidade do cliente é resolvida no final?
* *Etapas da percurso*: Quais são as etapas que o cliente percorre em sua percurso?
* *Dores*: Quais são os pontos fracos ou desafios do cliente?
* *Ganhos*: Quais são os ganhos ou benefícios do cliente?
* *Entradas e saídas*: Quais são as entradas e saídas em cada etapa?
* *Regras de interação e processamento*: Quais são as regras de interação e processamento em cada etapa?
#### Canvas de Domínio
Quais são as entidades principais e as regras de negócio relacionadas com a API?
* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?
* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?
* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?
* *Relações entre entidades*: Quais são as relações entre as entidades?
* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?
* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?
#### Canvas da Proposta de Valor da Capacidade
Que capacidade reutilizável criaria valor para os utilizadores sem decidir ainda se deve ser disponibilizada como API, evento, ficheiro, stream, produto de dados ou outro estilo de implementação?
* *Tarefas e resultados dos utilizadores*: O que os utilizadores, parceiros, utilizadores, sistemas ou equipas estão a tentar alcançar?
* *Funcionalidades da capacidade que permitem ganhos*: Que funcionalidades da capacidade ajudariam os utilizadores a alcançar melhores resultados, rapidez, automação, conhecimento, alcance ou conformidade?
* *Funcionalidades da capacidade que aliviam dores*: Que funcionalidades da capacidade removeriam atrito, trabalho manual, erros, atrasos, risco ou incerteza para os utilizadores?
* *Capacidades reutilizáveis*: Que capacidades de negócio ou de dados reutilizáveis poderiam servir estas tarefas, ganhos e dores em mais do que um utilizador ou caso de utilização?
#### Canvas do Modelo de Negócio da Capacidade
Quão viável, reutilizável, financiada, atribuída, apoiada e detetável deve ser esta capacidade de integração?
* *Proposta de valor da capacidade*: Que valor esta capacidade reutilizável oferece aos utilizadores e à organização ou ecossistema?
* *Segmentos de utilizadores da capacidade*: Quem são os utilizadores atuais e potenciais da capacidade, incluindo equipas, parceiros, sistemas, produtos ou utilizadores de dados?
* *Envolvimento dos utilizadores*: Como irão os utilizadores descobrir, avaliar, solicitar, integrar-se, obter apoio e dar feedback sobre a capacidade?
* *Canais*: Através de que catálogos, portais, marketplaces, sites de documentação, caminhos de apoio ou processos de governação os utilizadores irão interagir com a capacidade?
* *Recursos-chave*: Que sistemas, ativos de dados, plataformas, pessoas, normas, financiamento e capacidades operacionais são necessários?
* *Atividades-chave*: O que o responsável pela capacidade e os produtores devem fazer para conceber, entregar, governar, apoiar e melhorar a capacidade?
* *Parceiros-chave*: Que parceiros de negócio, tecnologia, dados, segurança, jurídico, plataforma ou externos são necessários para que a capacidade funcione?
* *Benefícios*: Que benefícios de negócio, operacionais, de ecossistema, reutilização, conformidade ou custo justificam a capacidade?
* *Custos*: Quais são os custos significativos de construir, operar, governar, apoiar e evoluir a capacidade?
h2. 2. Requisitos e integração de consumidores da integração
Recolha consumidores da integração, responsabilidades dos fornecedores, necessidades de integração, expectativas de serviço e restrições operacionais.
h3. Canvas questions
#### Canvas de Requisitos da Experiência do Utilizador
Que requisitos de experiência e requisitos não funcionais os utilizadores precisam /de esclarecer antes de decidir a melhor arquitetura de integração?
* *Objetivos dos utilizadores*: Quais são os objetivos de negócio, de fluxo de trabalho, de decisão, de automação ou de utilização de dados dos utilizadores?
* *Disponibilidade e atualidade*: Quando é que a capacidade deve estar disponível, quão atualizada deve estar a informação e que latência ou janelas de entrega importam?
* *Volume e desempenho*: Que volumes de pedidos, eventos, registos, ficheiros, lotes, utilizadores ou transações a capacidade deve suportar agora e no futuro?
* *Qualidade e consistência dos dados*: Que expectativas de exatidão, completude, consistência, ordenação, deduplicação, reconciliação ou validação têm os utilizadores?
* *Segurança, privacidade e conformidade*: Que restrições de identidade, autorização, confidencialidade, residência, consentimento, retenção, auditoria ou regulamentação se aplicam?
* *Integração e acesso*: Como devem os utilizadores encontrar, solicitar, testar, obter aprovação e começar a utilizar a capacidade?
* *Mudança e controlo de versões*: Que tolerância à mudança têm os utilizadores e que expectativas de aviso prévio, compatibilidade, migração ou controlo de versões se aplicam?
* *Observabilidade e apoio*: Que monitorização, estado, rastreabilidade, visibilidade da qualidade dos dados, apoio, propriedade e comunicação de incidentes os utilizadores precisam?
* *Recuperação e continuidade*: Que expectativas de repetição, nova tentativa, reconciliação, cópia de segurança, fallback, continuidade ou recuperação manual devem ser suportadas?
* *Implicações de arquitetura*: O que estes requisitos implicam para possíveis estilos de arquitetura, como APIs, eventos, ficheiros, streams, produtos de dados ou integração direta?
h3. Other related resources
* *Boas práticas de integração de API*: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.
h2. 3. Arquitetura de integracao e decisoes de plataforma
Selecionar a arquitetura de integracao, o estilo de implementacao e as capacidades de plataforma, tendo em conta as restricoes e o modelo de governacao.
h3. Canvas questions
#### Canvas de Impacto no Negócio
Quais são os possíveis impactos no negócio da falha da API?
* *Riscos de disponibilidade*: Quais são os riscos potenciais para a disponibilidade da API?
* *Mitigar riscos de disponibilidade*: Como o fornecedor da API pode mitigar os riscos de disponibilidade?
* *Riscos de segurança*: Quais são os riscos potenciais de segurança associados à API?
* *Mitigar riscos de segurança*: Como o fornecedor da API pode mitigar os riscos de segurança?
* *Riscos de dados*: Quais são os riscos potenciais para a integridade ou confidencialidade dos dados?
* *Mitigar riscos de dados*: Como o fornecedor da API pode mitigar os riscos de dados?
#### Canvas de Localização
Que fronteiras geopolíticas, regulamentares, de rede e de confiança afetam esta API?
* *Grupos de Localização / Confiança*: Quais são os grupos geopolíticos, regulamentares, de rede ou de confiança relevantes?
* *Características do grupo*: Quais são as características desses grupos, como residência, nível de confiança ou exposição de rede?
* *Locais / Zonas Relevantes*: Quais são os locais, zonas ou ambientes relevantes dentro de cada grupo?
* *Características de localização / zona*: Quais são as características dessas localizações ou zonas, tais como propriedade, região ou exposição?
* *Distâncias de Rede / Regulatórias*: Que distâncias de latência, confiança, regulatórias ou de conectividade existem entre os locais?
* *Características da Distância*: Quais são as características dessas distâncias, como sensibilidade à latência, restrições de residência ou limites de confiança?
* *Pontos de extremidade de conectividade*: Quais pontos de extremidade ou interfaces de conectividade estão associados aos locais?
* *Características de acesso aos pontos de extremidade*: Quais são as características desses pontos de extremidade, tais como exposição, protocolo, segurança ou restrições de acesso?
#### Canvas de Capacidade
Quanta capacidade é necessária para suportar o consumo da API?
* *Volumes de negócio atuais*: Quais são os volumes de negócio e as taxas de transação atuais?
* *Tendências de consumo futuro*: Quais são as tendências de consumo futuro previstas?
* *Requisitos de pico de carga e disponibilidade*: Quais são os requisitos de pico de carga e disponibilidade?
* *Estratégias de cache*: Quais estratégias de cache podem ser usadas para otimizar o desempenho?
* *Estratégias de limitação de pedidos*: Que estratégias de limitação de pedidos podem ser usadas para gerir o consumo?
* *Estratégias de dimensionamento*: Que estratégias de dimensionamento podem ser usadas para acomodar o crescimento?
h3. Other related resources
* *Diretrizes de integração de parceiros*: Listas de verificação de integração e padrões de comunicação para gerir os aspectos técnicos e legais das relações com APIs de terceiros.
h2. 4. Conceção da solução de integração
Conceber o contrato de interface, os esquemas, os payloads e os padroes de interacao para o estilo de integracao selecionado.
h3. Canvas questions
#### Canvas de Domínio
Quais são as entidades principais e as regras de negócio relacionadas com a API?
* *Etapas selecionadas da percurso do cliente*: Quais etapas da percurso do cliente são relevantes para este domínio?
* *Entidades principais e significado de negócio*: Quais são as entidades principais e seu significado de negócio?
* *Atributos e importância de negócio*: Quais são os principais atributos de cada entidade e sua importância de negócio?
* *Relações entre entidades*: Quais são as relações entre as entidades?
* *Regras de negócio, conformidade e integridade*: Quais são as regras de negócio, conformidade e integridade relacionadas com as entidades?
* *Considerações sobre segurança e privacidade*: Quais são as considerações sobre segurança e privacidade relacionadas com as entidades?
#### Canvas de Interação
Que tipos de interações esta API deve suportar antes de escolher uma conceção específica para o protocolo?
* *Interações CRUD*: As interações do tipo CRUD (Criar, Ler, Atualizar, Eliminar) são necessárias aqui?
* *Modelos de entrada e saída CRUD*: Quais são os modelos de entrada e saída para as interações CRUD, caso esse estilo seja necessário?
* *Processamento e validação CRUD*: Quais são as regras de processamento e validação para as interações CRUD, caso esse estilo seja necessário?
* *Interações orientadas por consulta*: Quais interações de leitura ou consulta são necessárias para responder às perguntas dos utilizadores?
* *Modelos de entrada e saída orientados por consulta*: Quais são os modelos de entrada e saída para as interações orientadas por consulta?
* *Processamento e validação orientados por consulta*: Quais são as regras de processamento e validação para as interações orientadas por consulta?
* *Interações orientadas por comando*: Quais comandos de alteração de estado são necessários, se houver?
* *Modelos de entrada e saída orientados por comando*: Quais são os modelos de entrada e saída para as interações orientadas por comando, caso esse estilo seja necessário?
* *Processamento e validação orientados por comando*: Quais são as regras de processamento e validação para as interações orientadas por comando, caso esse estilo seja necessário?
* *Interações orientadas por eventos*: Quais eventos precisam /de ser publicados ou consumidos, se houver?
* *Modelos de entrada e saída orientados por eventos*: Quais são os modelos de entrada e saída para as interações orientadas a eventos, caso esse estilo seja necessário?
* *Processamento e validação orientados por eventos*: Quais são as regras de processamento e validação para as interações orientadas por eventos, caso esse estilo seja necessário?
#### Canvas REST
Como a API pode ser concebida utilizando os princípios RESTful?
* *Recursos da API*: Quais são os principais recursos expostos pela API?
* *Modelo de recurso da API*: Qual é a estrutura do modelo de recurso da API?
* *Verbos da API*: Quais verbos HTTP são usados para interagir com os recursos da API?
* *Exemplo de verbo da API*: Forneça um exemplo de pedido e resposta da API para cada verbo.
#### Canvas de Eventos
Quais eventos são relevantes para a API e como são processados?
* *Tarefa do utilizador/gatilho*: Que ação do utilizador ou evento do sistema aciona esta operação de evento?
* *Entrada / Carga útil do evento*: Que dados estão incluídos na carga útil do evento recebido? Especifique os atributos principais.
* *Processamento/Lógica*: Descreva a lógica de processamento de back-end, incluindo validações, transformações ou decisões de encaminhamento.
* *Saída/Resultado do evento*: Que evento ou confirmação resultante é produzido? Inclua atributos da carga útil de saída.
#### Canvas GraphQL
Como a API pode ser concebida utilizando os princípios do GraphQL?
* *Nome da API*: Qual é o nome da API GraphQL ou do endpoint?
* *Objetivos do utilizador*: Que problemas os utilizadores da API estão a tentar resolver? De que dados precisam?
* *Tipos de chave*: Quais são os tipos principais expostos (por exemplo, Utilizador, Pedido, Produto)?
* *Relações*: Como os tipos se relacionam entre si em consultas aninhadas?
* *Consultas*: Quais consultas comuns devem ser suportadas?
* *Mutações*: Quais operações modificarão os dados (por exemplo, criar, atualizar, eliminar)?
* *Assinaturas*: Existem atualizações em tempo real ou eventos que os utilizadores podem assinar?
* *Regras de autorização*: Quem pode aceder quais campos ou tipos?
* *Restrições do utilizador*: Existem restrições de paginação, filtragem ou limitação de pedidos?
* *Notas/Questões em aberto*: Alguma decisão pendente ou considerações sobre integração?
h3. Other related resources
* *Guia de seleção do estilo de implementação*: Orientação para escolher entre API, evento, ficheiro, stream, produto de dados, integração direta ou estilos de implementação híbridos com base nos requisitos e restrições.
* *Primeira conceção do contrato*: Uma diretriz que defende abordagens API-first utilizando contratos formais (por exemplo, OpenAPI) para alinhar as partes interessadas antes do desenvolvimento.
h2. 5. Entrega e operações da integração
Construir, testar, automatizar, disponibilizar e operar a capacidade de integracao usando o estilo de implementacao selecionado e o contrato de interface validado.
h3. Station questions
* Utilize as Melhores Práticas de Desenvolvimento de API como orientação para implementar o contrato validado com frameworks e bibliotecas estabelecidos, garantindo que o resultado seja reutilizável e sustentável.
* Construa a implementação da API a partir do contrato validado usando frameworks, bibliotecas e padrões da equipa estabelecidos.
* Testar a funcionalidade, a segurança e o desempenho das APIs, utilizando ferramentas de teste automatizadas.
* Utilize pipelines CI/CD para automatizar os processos de construção, teste e implementação, garantindo uma qualidade e rastreabilidade consistentes.
* Garantir que as APIs cumprem os requisitos de segurança e conformidade através de verificações e auditorias automatizadas.
* Utilize a lista de verificação de auditoria da API para garantir que a API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
* Fornecer estruturas de codificação, bibliotecas e normas para a implementação de API. Implementar pipelines de CI/CD, estruturas de garantia de qualidade e ferramentas de automatização da disponibilização.
* Mesmo os melhores conceções de API falham se a entrega for inconsistente. Esta estação assegura que as suas APIs são construídas com qualidade, testadas exaustivamente e implementadas de forma fiável - permitindo iterações mais rápidas e maior confiança.
h3. Other related resources
* *Boas práticas de desenvolvimento de API*: Orientações de implementação para transformar um contrato de interface da API validado numa base de código de API consistente e sustentável, utilizando bibliotecas padrão, padrões reutilizáveis e fluxos de trabalho de desenvolvimento alinhados.
* *Boas práticas de teste de API*: Diretrizes para a implementação de testes automatizados funcionais, de desempenho e de segurança ao longo do ciclo de vida da API.
* *APIOps CI/CD para APIs*: Orientação de disponibilização que integra tarefas do ciclo de vida da API - design, teste, governação - em pipelines de integração e entrega contínuas.
* *Boas práticas de segurança da API*: Um conjunto de controlos acionáveis para proteger APIs, incluindo autenticação, autorização, encriptação, limitação de taxas e verificações de conformidade ao nível do pipeline.
* *Diretrizes de integração de parceiros*: Listas de verificação de integração e padrões de comunicação para gerir os aspectos técnicos e legais das relações com APIs de terceiros.
h2. 6. Garantia de prontidão da integração
Assegure a prontidão, a governação, a qualidade, a segurança, a conformidade e as evidências operacionais da integração antes da disponibilização.
h3. Station questions
* Realizar auditorias para garantir que as APIs cumprems normas organizacionais, técnicas e legais antes da publicação.
* Utilizar listas de controlo, linters e ferramentas de teste para verificar a consistência e a conformidade com as normas.
* Colaborar com as equipas de governação e especialistas no domínio para garantir que as APIs estão prontas para produção.
* Estabeleça um processo de auditoria consistente que avalie a prontidão da API em todas as etapas do ciclo de vida usando critérios, evidências e padrões definidos. Garanta que as lacunas sejam identificadas antecipadamente e resolvidas antes da publicação.
* As APIs são produtos de longa duração e devem atender às expectativas de qualidade, consistência e conformidade. A auditoria conecta as decisões de conceção, a implementação e a prontidão operacional a padrões definidos, reduzindo o risco antes da exposição.
h3. Other related resources
* *Lista de verificação de auditoria da API*: Uma lista de verificação baseada no ciclo de vida para verificar a prontidão da API em design, entrega, publicação e conformidade utilizando critérios de auditoria e evidências definidos.
* *Boas práticas de conformidade da API*: Garantir que as APIs cumprem conformidade legal, regulamentar e interna através de documentação, controlos e validações automatizadas.
h2. 7. Publicacao e enablement da integracao
Publicar a capacidade de integracao para que as equipas a possam descobrir, avaliar, solicitar acesso, concluir o onboarding, reutiliza-la e obter suporte.
h3. Station 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.
h3. Other related resources
* *Boas práticas de integração de API*: Boas práticas para simplificar as jornadas de integração do utilizador da API com registo passo a passo, descoberta e orientação na primeira chamada.
* *Modelo de contrato de serviço*: Um formato de acordo personalizável que define expectativas, SLAs, responsabilidades e termos de acesso para o consumo de API.
h2. 8. Monitorização e melhoria da integração
Monitorize a fiabilidade da integração, a reutilização, os incidentes, o desempenho, os resultados dos consumidores e as necessidades de melhoria.
h3. Station questions
* Monitorizar as métricas de desempenho (por exemplo, chamadas APIs, latência, taxas de erro) e as métricas de adoção (por exemplo, NPS).
* Analisar as métricas de utilização da API e incorporar o feedback dos utilizadores nas iterações da API.
* Crie o hábito de analisar os indicadores e planear actividades de melhoria contínua.
* Criar quadros analíticos para acompanhar o desempenho e o envolvimento. Desenvolver ciclos de feedback, ferramentas de análise e estratégias de envolvimento para APIs.
* A entrega da API não pára no lançamento. Sem monitorização, as equipas não podem melhorar a adoção, o desempenho ou o ROI. Esta estação garante que as APIs permaneçam úteis, seguras e evoluindo com as necessidades do negócio.
h3. Other related resources
* *Métricas e análise de API*: Um recurso para definir, recolher e analisar o desempenho da API e os dados de utilização para alinhar os KPIs técnicos com os resultados de negócio.
* *Estratégias de envolvimento da comunidade API*: Um manual para promover a adoção de APIs, cultivando comunidades através de conteúdos, canais de apoio, ciclos de feedback e estratégias de envolvimento social.