Um ciclo para identificar, conceber, entregar, capacitar e melhorar oportunidades de automação.
Transformar oportunidades de automação em fluxos de trabalho governados com utilizadores, plataformas, controlos, percursos de entrega, capacitação e monitorização claros.
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
O desenho da interface e as capacidades expostas são rastreáveis ao valor de negócio e às necessidades dos utilizadores.
O workflow, as regras, as integrações e os contratos de interface relevantes foram validados e testados.
A solução passa as verificações de qualidade, segurança, conformidade e prontidão.
Identifique e priorize oportunidades de automação por valor, viabilidade, risco, propriedade e impacto esperado no processo.
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 utilizadores do processo, funções, transferências, exceções, restrições e expectativas de serviço antes de conceber a automação.
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.
Escolher a plataforma de automacao, o runtime, a abordagem de integracao, os controlos de governacao e as restricoes operacionais.
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 fluxo de trabalho de automacao, os gatilhos, os pontos de decisao, as integracoes, o tratamento de dados, os contratos de interface relevantes e os caminhos de excecao.
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.
Construa, teste, disponibilize, documente e opere a automação com propriedade, controlos e caminhos de reversão claros.
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.
Reveja a prontidão, a qualidade, o risco, a conformidade, a supervisão humana, as evidências e os critérios de disponibilização da automaçã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.
Capacite utilizadores e operadores com descoberta, integração, instruções operacionais, caminhos de suporte e comunicação de alterações.
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 o desempenho da automação, exceções, fiabilidade, resultados dos utilizadores, impacto operacional e oportunidades 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 Automação question template
Um ciclo para identificar, conceber, entregar, capacitar e melhorar oportunidades de automação.
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 oportunidade de automação
Identifique e priorize oportunidades de automação por valor, viabilidade, risco, propriedade e impacto esperado no processo.
### 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?
## 2. Requisitos do processo e dos utilizadores
Recolha utilizadores do processo, funções, transferências, exceções, restrições e expectativas de serviço antes de conceber a automação.
### 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?
## 3. Decisão de plataforma de automação
Escolher a plataforma de automacao, o runtime, a abordagem de integracao, os controlos de governacao e as restricoes operacionais.
### 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
- **Guia de responsabilidade operacional da automatização**: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.
## 4. Conceção do fluxo de trabalho de automação
Conceber o fluxo de trabalho de automacao, os gatilhos, os pontos de decisao, as integracoes, o tratamento de dados, os contratos de interface relevantes e os caminhos de excecao.
### 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
- **Guia de desenho do processo e workflow**: Orientação para modelar passos do processo, papéis, passagens de responsabilidade, pontos de decisão, estados, entradas, saídas e exceções que moldam um workflow de automatização.
- **Guia de decisões e regras de negócio**: Orientação para captar regras, limiares, decisões, aprovações, verificações de elegibilidade e responsabilidade pelas regras no desenho de automatizações.
- **Guia de gatilhos, passagens de responsabilidade e exceções da automatização**: Orientação para definir gatilhos de automatização, passagens para intervenção humana, tratamento de exceções, tentativas repetidas, ações compensatórias e caminhos de escalamento de suporte.
## 5. Entrega e operacao da automacao
Construa, teste, disponibilize, documente e opere a automação com propriedade, controlos e caminhos de reversão claros.
### 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
- **Guia de testes de automatização**: Orientação para testar workflows automatizados, decisões, integrações, exceções, comportamento de rollback, supervisão e impacto nos utilizadores antes da publicação.
- **Guia de responsabilidade operacional da automatização**: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.
- **Guia de rollback e supervisão da automatização**: Orientação para desenhar caminhos de rollback, pausa, substituição manual, monitorização, supervisão e recuperação para automatizações.
## 6. Revisão de prontidão da automação
Reveja a prontidão, a qualidade, o risco, a conformidade, a supervisão humana, as evidências e os critérios de disponibilização da automaçã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
- **Checklist de prontidão da automatização**: Uma checklist para validar workflow de automatização, controlos, risco, conformidade, supervisão humana, evidências de teste, rollback, operações e prontidão para publicação.
- **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. Rollout e enablement da automacao
Capacite utilizadores e operadores com descoberta, integração, instruções operacionais, caminhos de suporte e comunicação de alterações.
### 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
- **Guia de rollout e enablement da automatização**: Orientação para implementar automatizações com comunicação aos utilizadores, onboarding, instruções operacionais, caminhos de suporte, gestão da mudança e ciclos de feedback.
- **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 automação
Monitorize o desempenho da automação, exceções, fiabilidade, resultados dos utilizadores, impacto operacional e oportunidades 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
- **Guia de responsabilidade operacional da automatização**: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.
- **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.
Confluence-wiki
h1. Ciclo de Automação question template
Um ciclo para identificar, conceber, entregar, capacitar e melhorar oportunidades de automaçã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. Estratégia da oportunidade de automação
Identifique e priorize oportunidades de automação por valor, viabilidade, risco, propriedade e impacto esperado no processo.
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?
h2. 2. Requisitos do processo e dos utilizadores
Recolha utilizadores do processo, funções, transferências, exceções, restrições e expectativas de serviço antes de conceber a automação.
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?
h2. 3. Decisão de plataforma de automação
Escolher a plataforma de automacao, o runtime, a abordagem de integracao, os controlos de governacao e as restricoes operacionais.
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
* *Guia de responsabilidade operacional da automatização*: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.
h2. 4. Conceção do fluxo de trabalho de automação
Conceber o fluxo de trabalho de automacao, os gatilhos, os pontos de decisao, as integracoes, o tratamento de dados, os contratos de interface relevantes e os caminhos de excecao.
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
* *Guia de desenho do processo e workflow*: Orientação para modelar passos do processo, papéis, passagens de responsabilidade, pontos de decisão, estados, entradas, saídas e exceções que moldam um workflow de automatização.
* *Guia de decisões e regras de negócio*: Orientação para captar regras, limiares, decisões, aprovações, verificações de elegibilidade e responsabilidade pelas regras no desenho de automatizações.
* *Guia de gatilhos, passagens de responsabilidade e exceções da automatização*: Orientação para definir gatilhos de automatização, passagens para intervenção humana, tratamento de exceções, tentativas repetidas, ações compensatórias e caminhos de escalamento de suporte.
h2. 5. Entrega e operacao da automacao
Construa, teste, disponibilize, documente e opere a automação com propriedade, controlos e caminhos de reversão claros.
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
* *Guia de testes de automatização*: Orientação para testar workflows automatizados, decisões, integrações, exceções, comportamento de rollback, supervisão e impacto nos utilizadores antes da publicação.
* *Guia de responsabilidade operacional da automatização*: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.
* *Guia de rollback e supervisão da automatização*: Orientação para desenhar caminhos de rollback, pausa, substituição manual, monitorização, supervisão e recuperação para automatizações.
h2. 6. Revisão de prontidão da automação
Reveja a prontidão, a qualidade, o risco, a conformidade, a supervisão humana, as evidências e os critérios de disponibilização da automaçã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
* *Checklist de prontidão da automatização*: Uma checklist para validar workflow de automatização, controlos, risco, conformidade, supervisão humana, evidências de teste, rollback, operações e prontidão para publicação.
* *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. Rollout e enablement da automacao
Capacite utilizadores e operadores com descoberta, integração, instruções operacionais, caminhos de suporte e comunicação de alterações.
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
* *Guia de rollout e enablement da automatização*: Orientação para implementar automatizações com comunicação aos utilizadores, onboarding, instruções operacionais, caminhos de suporte, gestão da mudança e ciclos de feedback.
* *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 automação
Monitorize o desempenho da automação, exceções, fiabilidade, resultados dos utilizadores, impacto operacional e oportunidades 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
* *Guia de responsabilidade operacional da automatização*: Orientação para definir responsabilidade, runbooks, supervisão, suporte, monitorização, controlo de alterações e responsabilidades de melhoria contínua para automatizações.
* *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.