Antes de construir qualquer coisa, defina o valor da sua API, os utilizadores e os objetivos de negócio desde o primeiro dia.
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.
Certifique-se de que a sua API é detetável, compreensível e utilizável - antes e depois do lançamento.
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.
Garanta a escalabilidade, a reutilização e a governação da sua API e dos componentes da plataforma.
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.
Criar conceções de API que sejam consistentes, reutilizáveis e baseados na intenção de negócios e em padrões compartilhados.
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.
Criar, testar e lançar APIs usando pipelines de entrega modernos e boas práticas de engenharia.
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.
Valide se as APIs satisfazemos padrões de negócio, conceção e operacionais antes da publicação e exposiçã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.
Exponha as APIs de forma segura e clara ao público certo com a documentação e os processos corretos.
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.
Utilizar métricas e feedback para acompanhar o desempenho da API e promover a melhoria contínua.
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 API question template
A jornada APIOps Cycles focada em API para transformar APIs em produto, concebê-las, entregá-las, publicá-las e melhorá-las.
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 de produto API
Antes de construir qualquer coisa, defina o valor da sua API, os utilizadores e os objetivos de negócio desde o primeiro dia.
### 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 API
Como a percurso do cliente se relaciona com as APIs? Quais dificuldades e benefícios dos utilizadores finais e utilizadores de API precisam /de ser abordados?
- **Tarefas**: O que os clientes (utilizadores finais) estão a tentar alcançar?
- **Recursos que possibilitam ganhos**: Que funcionalidades permitem que os utilizadores finais e utilizadores de API alcancem ganhos?
- **Recursos que aliviam dificuldades**: Que funcionalidades ajudam os utilizadores finais e os utilizadores da API a superar dificuldades?
- **Produtos API**: Quais produtos e recursos API atendem às tarefas, dificuldades e ganhos?
#### Canvas do Modelo de Negócio da API
Qual será a viabilidade e a reutilização desta API? Temos um caso de negócio do ponto de vista de custo-benefício?
- **Proposta de valor da API**: Comece com uma nota adesiva que nomeie a API ou a família de APIs e, em seguida, anote o valor que a API oferece aos seus utilizadores.
- **Segmentos de utilizadores da API**: Quem é o público-alvo da API?
- **Relações com programadores**: Como o fornecedor da API alcança e oferece apoio aos utilizadores da API?
- **Canais**: Através de quais mecanismos os utilizadores da API interagem com a API?
- **Recursos-chave**: Que ativos estratégicos exclusivos deve o fornecedor da API adquirir ou construir?
- **Atividades-chave**: Quais são as ações mais importantes que o fornecedor da API deve realizar para operar com sucesso?
- **Parceiros-chave**: Quem são as principais partes interessadas envolvidas?
- **Benefícios**: Quais são os benefícios significativos ou fluxos de receita gerados pela API?
- **Custos**: Quais são os custos significativos envolvidos na construção, disponibilização e operação da API?
## 2. Experiência do consumidor da API
Certifique-se de que a sua API é detetável, compreensível e utilizável - antes e depois do lançamento.
### Canvas questions
#### Canvas da Proposta de Valor da API
Como a percurso do cliente se relaciona com as APIs? Quais dificuldades e benefícios dos utilizadores finais e utilizadores de API precisam /de ser abordados?
- **Tarefas**: O que os clientes (utilizadores finais) estão a tentar alcançar?
- **Recursos que possibilitam ganhos**: Que funcionalidades permitem que os utilizadores finais e utilizadores de API alcancem ganhos?
- **Recursos que aliviam dificuldades**: Que funcionalidades ajudam os utilizadores finais e os utilizadores da API a superar dificuldades?
- **Produtos API**: Quais produtos e recursos API atendem às tarefas, dificuldades e ganhos?
#### 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?
### 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 da plataforma API
Garanta a escalabilidade, a reutilização e a governação da sua API e dos componentes da plataforma.
### 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
- **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.
## 4. Conceção da API
Criar conceções de API que sejam consistentes, reutilizáveis e baseados na intenção de negócios e em padrões compartilhados.
### 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
- **Princípios de conceção da API**: Um guia conciso sobre usabilidade, descobribilidade e consistência da API, baseado em regras de design partilhadas e nas necessidades reais dos utilizadores.
- **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 da API
Criar, testar e lançar APIs usando pipelines de entrega modernos e boas práticas de engenharia.
### 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.
## 6. Auditoria da API
Valide se as APIs satisfazemos padrões de negócio, conceção e operacionais antes da publicação e exposiçã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. Publicação da API
Exponha as APIs de forma segura e clara ao público certo com a documentação e os processos corretos.
### 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
- **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 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.
- **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.
## 8. Monitorizacao e melhoria da API
Utilizar métricas e feedback para acompanhar o desempenho da API e promover a melhoria contínua.
### 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 API question template
A jornada APIOps Cycles focada em API para transformar APIs em produto, concebê-las, entregá-las, publicá-las e melhorá-las.
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 de produto API
Antes de construir qualquer coisa, defina o valor da sua API, os utilizadores e os objetivos de negócio desde o primeiro dia.
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 API
Como a percurso do cliente se relaciona com as APIs? Quais dificuldades e benefícios dos utilizadores finais e utilizadores de API precisam /de ser abordados?
* *Tarefas*: O que os clientes (utilizadores finais) estão a tentar alcançar?
* *Recursos que possibilitam ganhos*: Que funcionalidades permitem que os utilizadores finais e utilizadores de API alcancem ganhos?
* *Recursos que aliviam dificuldades*: Que funcionalidades ajudam os utilizadores finais e os utilizadores da API a superar dificuldades?
* *Produtos API*: Quais produtos e recursos API atendem às tarefas, dificuldades e ganhos?
#### Canvas do Modelo de Negócio da API
Qual será a viabilidade e a reutilização desta API? Temos um caso de negócio do ponto de vista de custo-benefício?
* *Proposta de valor da API*: Comece com uma nota adesiva que nomeie a API ou a família de APIs e, em seguida, anote o valor que a API oferece aos seus utilizadores.
* *Segmentos de utilizadores da API*: Quem é o público-alvo da API?
* *Relações com programadores*: Como o fornecedor da API alcança e oferece apoio aos utilizadores da API?
* *Canais*: Através de quais mecanismos os utilizadores da API interagem com a API?
* *Recursos-chave*: Que ativos estratégicos exclusivos deve o fornecedor da API adquirir ou construir?
* *Atividades-chave*: Quais são as ações mais importantes que o fornecedor da API deve realizar para operar com sucesso?
* *Parceiros-chave*: Quem são as principais partes interessadas envolvidas?
* *Benefícios*: Quais são os benefícios significativos ou fluxos de receita gerados pela API?
* *Custos*: Quais são os custos significativos envolvidos na construção, disponibilização e operação da API?
h2. 2. Experiência do consumidor da API
Certifique-se de que a sua API é detetável, compreensível e utilizável - antes e depois do lançamento.
h3. Canvas questions
#### Canvas da Proposta de Valor da API
Como a percurso do cliente se relaciona com as APIs? Quais dificuldades e benefícios dos utilizadores finais e utilizadores de API precisam /de ser abordados?
* *Tarefas*: O que os clientes (utilizadores finais) estão a tentar alcançar?
* *Recursos que possibilitam ganhos*: Que funcionalidades permitem que os utilizadores finais e utilizadores de API alcancem ganhos?
* *Recursos que aliviam dificuldades*: Que funcionalidades ajudam os utilizadores finais e os utilizadores da API a superar dificuldades?
* *Produtos API*: Quais produtos e recursos API atendem às tarefas, dificuldades e ganhos?
#### 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?
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 da plataforma API
Garanta a escalabilidade, a reutilização e a governação da sua API e dos componentes da plataforma.
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
* *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.
h2. 4. Conceção da API
Criar conceções de API que sejam consistentes, reutilizáveis e baseados na intenção de negócios e em padrões compartilhados.
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
* *Princípios de conceção da API*: Um guia conciso sobre usabilidade, descobribilidade e consistência da API, baseado em regras de design partilhadas e nas necessidades reais dos utilizadores.
* *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 da API
Criar, testar e lançar APIs usando pipelines de entrega modernos e boas práticas de engenharia.
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.
h2. 6. Auditoria da API
Valide se as APIs satisfazemos padrões de negócio, conceção e operacionais antes da publicação e exposiçã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. Publicação da API
Exponha as APIs de forma segura e clara ao público certo com a documentação e os processos corretos.
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
* *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 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.
* *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.
h2. 8. Monitorizacao e melhoria da API
Utilizar métricas e feedback para acompanhar o desempenho da API e promover a melhoria contínua.
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.