Um ciclo para transformar capacidades de negócio em capacidades digitais reutilizáveis antes de selecionar o estilo de implementação.
Identificar e transformar capacidades digitais reutilizaveis em produto antes de escolher um estilo de implementacao API, evento, ficheiro, stream, produto de dados, servico com IA, 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.
As partes interessadas relevantes concordam que vale a pena explorar e priorizar esta oportunidade de capacidade.
Critérios de saída
A proposta de valor da capacidade foi validada com partes interessadas de negócio e utilizadores.
A arquitetura, plataforma e estilo de implementação escolhidos foram validados com as partes interessadas relevantes de arquitetura, segurança e plataforma.
A solução passa as verificações de qualidade, segurança, conformidade e prontidão.
Antes de construir qualquer coisa, defina o valor, os consumidores, a propriedade e os objetivos de negócio da capacidade.
O trabalho de integração e API salta muitas vezes demasiado cedo para um padrão técnico. Esta estação mantém a equipa focada na jornada de negócio, no significado do domínio, no valor, no potencial de reutilização, na propriedade e na viabilidade antes de selecionar APIs, eventos, ficheiros, streams, produtos de dados ou integração direta.
Recolha requisitos de integração dos consumidores, normas, requisitos não funcionais, expectativas de serviço, restrições, necessidades de segurança, protocolos permitidos, atualidade dos dados, SLAs, observabilidade, recuperação, requisitos de adoção e responsabilidades dos produtores.
A arquitetura certa depende dos objetivos dos consumidores, das expectativas de integração, dos níveis de serviço, das necessidades de qualidade dos dados, da tolerância à mudança, da observabilidade, do suporte e das restrições dos produtores.
Utilize requisitos e restrições para decidir o padrão de arquitetura certo e as capacidades de plataforma de suporte.
As escolhas de arquitetura devem resultar de evidências sobre impacto de negócio, localizações, fronteiras de confiança, capacidade, latência, propriedade dos dados, consistência, operabilidade, segurança, privacidade, governação e custo.
Conceba o contrato de interface e o modelo de interação para o estilo de disponibilização selecionado.
Depois de conhecido o padrão de arquitetura, a conceção deve transformar os requisitos da capacidade em contratos de interface, interações, esquemas, regras de dados, expectativas de ciclo de vida e obrigações dos consumidores claros.
Construa, teste, disponibilize e opere a capacidade usando o estilo de disponibilização selecionado e o contrato de interface validado.
Uma capacidade reutilizável precisa de entrega e operações fiáveis, quer se torne uma API, stream de eventos, troca de ficheiros, produto de dados ou integração direta.
Audite o contrato de interface, os controlos, o modelo de suporte, a observabilidade, a documentação e a prontidão de ciclo de vida da capacidade antes da disponibilização.
As capacidades reutilizáveis criam riscos operacionais, de dados, segurança, privacidade, conformidade e impacto nos consumidores. As verificações de prontidão reduzem surpresas antes da publicação ou utilização em produção.
Publique informação sobre a capacidade reutilizável para que os consumidores a possam descobrir, solicitar, integrar, utilizar e obter suporte.
As capacidades reutilizáveis só criam valor quando os consumidores as conseguem encontrar, compreender o respetivo contrato de interface e expectativas de serviço, solicitar acesso e saber quem é responsável pelo suporte e pelas decisões de ciclo de vida.
Monitorize a utilização, fiabilidade, qualidade dos dados, resultados dos consumidores, custo operacional e oportunidades de reutilização após a disponibilização.
As capacidades precisam de feedback contínuo para permanecerem fiáveis, valiosas, rentáveis e reutilizáveis à medida que consumidores, sistemas, dados e plataformas mudam.
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 Capacidades question template
Um ciclo para transformar capacidades de negócio em capacidades digitais reutilizáveis antes de selecionar o estilo de implementação.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
## 1. Estrategia da capacidade
Antes de construir qualquer coisa, defina o valor, os consumidores, a propriedade e os objetivos de negócio da capacidade.
### 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 onboarding de utilizadores
Recolha requisitos de integração dos consumidores, normas, requisitos não funcionais, expectativas de serviço, restrições, necessidades de segurança, protocolos permitidos, atualidade dos dados, SLAs, observabilidade, recuperação, requisitos de adoção e responsabilidades dos produtores.
### 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. Decisões de arquitetura e plataforma
Utilize requisitos e restrições para decidir o padrão de arquitetura certo e as capacidades de plataforma de suporte.
### 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?
## 4. Conceção da solução e da interface
Conceba o contrato de interface e o modelo de interação para o estilo de disponibilização 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?
### Other related resources
- **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
Construa, teste, disponibilize e opere a capacidade usando o estilo de disponibilização selecionado e o contrato de interface validado.
### Station questions
- Utilize boas práticas de desenvolvimento para implementar o contrato de interface validado com frameworks, bibliotecas e normas da equipa estabelecidos.
- Construa a implementação a partir do contrato de interface validado, usando frameworks, bibliotecas e normas da equipa estabelecidos.
- Utilize orientação de testes para verificar funcionalidade, qualidade dos dados, compatibilidade, segurança, desempenho, resiliência e expectativas de recuperação.
- Utilize orientação de CI/CD para automatizar construção, testes, disponibilização, configuração e rastreabilidade.
- Utilize orientação de segurança para proteger dados, acesso, credenciais e fronteiras da plataforma.
- Utilize a lista de verificação de auditoria para garantir que a solução cumpre requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
- Aplique orientação de entrega, testes, CI/CD, operações e segurança ao estilo de disponibilização escolhido.
- Uma capacidade reutilizável precisa de entrega e operações fiáveis, quer se torne uma API, stream de eventos, troca de ficheiros, produto de dados ou integração direta.
### 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.
## 6. Garantia de qualidade e prontidão
Audite o contrato de interface, os controlos, o modelo de suporte, a observabilidade, a documentação e a prontidão de ciclo de vida da capacidade antes da disponibilização.
### Station questions
- Utilize a lista de verificação de auditoria como checklist de qualidade reutilizável para contrato de interface, documentação, segurança, desempenho e prontidão de conformidade.
- Utilize checklists, linters e ferramentas de teste para verificar consistência e conformidade com normas.
- Colabore com equipas de governação e especialistas de domínio para garantir que a capacidade está pronta para produção.
- Utilize recursos de auditoria e conformidade para verificar que a capacidade está pronta para disponibilização controlada e reutilização.
- As capacidades reutilizáveis criam riscos operacionais, de dados, segurança, privacidade, conformidade e impacto nos consumidores. As verificações de prontidão reduzem surpresas antes da publicação ou utilização em produçã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
Publique informação sobre a capacidade reutilizável para que os consumidores a possam descobrir, solicitar, integrar, utilizar e obter suporte.
### Station questions
- Publique informação sobre a capacidade nos catálogos, portais, gateways ou ambientes adequados para apoiar a reutilização por vários consumidores.
- Documente como os consumidores encontram e utilizam a capacidade, incluindo processos de integração e registo.
- Garanta que os modelos de segurança, a configuração de acesso e os termos legais são claros e acessíveis aos consumidores.
- Publique propriedade, documentação, integração, contactos de suporte, expectativas de serviço, estado de ciclo de vida e caminhos para pedidos de acesso.
- As capacidades reutilizáveis só criam valor quando os consumidores as conseguem encontrar, compreender o respetivo contrato de interface e expectativas de serviço, solicitar acesso e saber quem é responsável pelo suporte e pelas decisões de ciclo de vida.
### 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
Monitorize a utilização, fiabilidade, qualidade dos dados, resultados dos consumidores, custo operacional e oportunidades de reutilização após a disponibilização.
### Station questions
- Utilize orientação de métricas e análise para definir medidas de utilização da capacidade, fiabilidade, qualidade dos dados, custo, adoção e valor para os consumidores.
- Analise métricas de utilização e incorpore feedback dos consumidores nas iterações da capacidade.
- Estabeleça o hábito de rever métricas e planear atividades de melhoria contínua.
- Utilize práticas de métricas, análise e envolvimento para melhorar a capacidade ao longo do tempo.
- As capacidades precisam de feedback contínuo para permanecerem fiáveis, valiosas, rentáveis e reutilizáveis à medida que consumidores, sistemas, dados e plataformas mudam.
### 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 Capacidades question template
Um ciclo para transformar capacidades de negócio em capacidades digitais reutilizáveis antes de selecionar o estilo de implementação.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
h2. 1. Estrategia da capacidade
Antes de construir qualquer coisa, defina o valor, os consumidores, a propriedade e os objetivos de negócio da capacidade.
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 onboarding de utilizadores
Recolha requisitos de integração dos consumidores, normas, requisitos não funcionais, expectativas de serviço, restrições, necessidades de segurança, protocolos permitidos, atualidade dos dados, SLAs, observabilidade, recuperação, requisitos de adoção e responsabilidades dos produtores.
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. Decisões de arquitetura e plataforma
Utilize requisitos e restrições para decidir o padrão de arquitetura certo e as capacidades de plataforma de suporte.
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?
h2. 4. Conceção da solução e da interface
Conceba o contrato de interface e o modelo de interação para o estilo de disponibilização 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?
h3. Other related resources
* *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
Construa, teste, disponibilize e opere a capacidade usando o estilo de disponibilização selecionado e o contrato de interface validado.
h3. Station questions
* Utilize boas práticas de desenvolvimento para implementar o contrato de interface validado com frameworks, bibliotecas e normas da equipa estabelecidos.
* Construa a implementação a partir do contrato de interface validado, usando frameworks, bibliotecas e normas da equipa estabelecidos.
* Utilize orientação de testes para verificar funcionalidade, qualidade dos dados, compatibilidade, segurança, desempenho, resiliência e expectativas de recuperação.
* Utilize orientação de CI/CD para automatizar construção, testes, disponibilização, configuração e rastreabilidade.
* Utilize orientação de segurança para proteger dados, acesso, credenciais e fronteiras da plataforma.
* Utilize a lista de verificação de auditoria para garantir que a solução cumpre requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
* Aplique orientação de entrega, testes, CI/CD, operações e segurança ao estilo de disponibilização escolhido.
* Uma capacidade reutilizável precisa de entrega e operações fiáveis, quer se torne uma API, stream de eventos, troca de ficheiros, produto de dados ou integração direta.
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.
h2. 6. Garantia de qualidade e prontidão
Audite o contrato de interface, os controlos, o modelo de suporte, a observabilidade, a documentação e a prontidão de ciclo de vida da capacidade antes da disponibilização.
h3. Station questions
* Utilize a lista de verificação de auditoria como checklist de qualidade reutilizável para contrato de interface, documentação, segurança, desempenho e prontidão de conformidade.
* Utilize checklists, linters e ferramentas de teste para verificar consistência e conformidade com normas.
* Colabore com equipas de governação e especialistas de domínio para garantir que a capacidade está pronta para produção.
* Utilize recursos de auditoria e conformidade para verificar que a capacidade está pronta para disponibilização controlada e reutilização.
* As capacidades reutilizáveis criam riscos operacionais, de dados, segurança, privacidade, conformidade e impacto nos consumidores. As verificações de prontidão reduzem surpresas antes da publicação ou utilização em produçã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
Publique informação sobre a capacidade reutilizável para que os consumidores a possam descobrir, solicitar, integrar, utilizar e obter suporte.
h3. Station questions
* Publique informação sobre a capacidade nos catálogos, portais, gateways ou ambientes adequados para apoiar a reutilização por vários consumidores.
* Documente como os consumidores encontram e utilizam a capacidade, incluindo processos de integração e registo.
* Garanta que os modelos de segurança, a configuração de acesso e os termos legais são claros e acessíveis aos consumidores.
* Publique propriedade, documentação, integração, contactos de suporte, expectativas de serviço, estado de ciclo de vida e caminhos para pedidos de acesso.
* As capacidades reutilizáveis só criam valor quando os consumidores as conseguem encontrar, compreender o respetivo contrato de interface e expectativas de serviço, solicitar acesso e saber quem é responsável pelo suporte e pelas decisões de ciclo de vida.
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
Monitorize a utilização, fiabilidade, qualidade dos dados, resultados dos consumidores, custo operacional e oportunidades de reutilização após a disponibilização.
h3. Station questions
* Utilize orientação de métricas e análise para definir medidas de utilização da capacidade, fiabilidade, qualidade dos dados, custo, adoção e valor para os consumidores.
* Analise métricas de utilização e incorpore feedback dos consumidores nas iterações da capacidade.
* Estabeleça o hábito de rever métricas e planear atividades de melhoria contínua.
* Utilize práticas de métricas, análise e envolvimento para melhorar a capacidade ao longo do tempo.
* As capacidades precisam de feedback contínuo para permanecerem fiáveis, valiosas, rentáveis e reutilizáveis à medida que consumidores, sistemas, dados e plataformas mudam.
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.