# Experiência do consumidor da API - Conceção para os utilizadores reais da sua API Canonical page: https://apiopscycles.com/pt/stations/api-consumer-experience Language: pt Entity ID: api-consumer-experience ## Description Certifique-se de que a sua API é detetável, compreensível e utilizável - antes e depois do lançamento. ## Why it matters 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. ## Apply in work Fornecer diretrizes, ferramentas e mecanismos de feedback para compreender, analisar e melhorar a experiência interna e externa dos programadores e parceiros. ## Outcomes - Identifique e dê prioridade aos seus consumidores de API - Definir o percurso da experiência API - Planeamento da integração, documentação e feedback - Melhorar a adoção através de empatia genuína + Experiência do Programador (DX) ## Steps 1. Analise o Canvas da Proposta de Valor da API existente sob a perspectiva do consumidor da API. Mantenha as tarefas de negócios suportadas estáveis ​​e enriqueça os recursos que aliviam problemas e possibilitam ganhos com as preocupações do consumidor da API, para que elas possam orientar as decisões de conceção futuras. 2. Utilize o Canvas do Percurso do Cliente para a jornada do consumidor da API, desde a descoberta e avaliação até a integração, resolução de problemas e uso contínuo. 3. Utilize a jornada resultante para melhorar a integração, a documentação, o suporte e os ciclos de feedback para o consumidor da API. ## Questions - Analise o Canvas da Proposta de Valor da API existente sob a perspectiva do consumidor da API. Mantenha as tarefas de negócios suportadas estáveis ​​e enriqueça os recursos que aliviam problemas e possibilitam ganhos com as preocupações do consumidor da API, para que elas possam orientar as decisões de conceção futuras. - Utilize o Canvas do Percurso do Cliente para a jornada do consumidor da API, desde a descoberta e avaliação até a integração, resolução de problemas e uso contínuo. - Utilize a jornada resultante para melhorar a integração, a documentação, o suporte e os ciclos de feedback para o consumidor da API. - Fornecer diretrizes, ferramentas e mecanismos de feedback para compreender, analisar e melhorar a experiência interna e externa dos programadores e parceiros. - 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. ## Evidence - design-artifact - documentation - consumer-feedback ## Completion criteria - A oportunidade de capacidade está identificada e documentada. — Individual API opportunities are identified and documented. (ID: api-opportunity-documented) - A capacidade responde a uma necessidade clara de negócio e é reutilizável pelos utilizadores previstos. — The API meets a clear business need and is reusable for multiple API consumers. (ID: api-reusability) - A interface selecionada fornece uma abstração adequada aos utilizadores. — The API is intended to shield consumers from backend complexity and inconsistencies. (ID: hide-backend-discrepancies) - A proposta de valor da capacidade foi validada com partes interessadas de negócio e utilizadores. — The API value proposition has been reviewed and validated with the relevant business and consumer stakeholders. (ID: value-prop-validated) - Os segmentos de utilizadores estão identificados. — API consumer segments (internal and external) are identified. (ID: consumer-segments-identified) - Está definido um roadmap de implementação de alto nível. — High-level roadmaps for API development are established. (ID: api-roadmap-defined) ## Role participation and responsibilities - [Representante de cliente ou parceiro](https://apiopscycles.com/pt/roles/customer-specialist.md) (lead): Contribui com a perspetiva do cliente ou parceiro para o percurso, valor e modelo de colaboração.; suggested-answer-owner: [Canvas de compromissos do consumidor e produtor da capacidade](https://apiopscycles.com/pt/resources/capability-consumer-producer-requirements-canvas.md) - [Representante dos utilizadores da API](https://apiopscycles.com/pt/roles/api-consumer-specialist.md) (lead): Representa as necessidades de programadores, integradores ou outros utilizadores que utilizam a API diretamente.; suggested-answer-owner: [Canvas de compromissos do consumidor e fornecedor de integração](https://apiopscycles.com/pt/resources/integration-consumer-provider-requirements-canvas.md) - [Responsável pelo processo](https://apiopscycles.com/pt/roles/process-owner.md) (lead): Responsável pelo processo de negócio a automatizar, incluindo objetivos, regras, resultados e prioridades de melhoria. - [Responsável pelo produto API](https://apiopscycles.com/pt/roles/api-product-owner.md) (lead): Conduz a oportunidade API, a priorização e as decisões ao nível do produto ao longo do ciclo de vida. - [Arquiteto de integração](https://apiopscycles.com/pt/roles/integration-architect.md) (core): Desenha abordagens de integração e estilos de implementação que ligam a capacidade ou API a outros sistemas. - [Especialista de domínio](https://apiopscycles.com/pt/roles/domain-specialist.md) (core): Traz conhecimento profundo do domínio de negócio, conceitos, regras e restrições que a capacidade ou interface deve refletir. - [Responsável pela automatização](https://apiopscycles.com/pt/roles/automation-owner.md) (core): Responsável pelos objetivos, valor de negócio, prioridades, controlos e resultados do ciclo de vida da automatização. - [Responsável pela capacidade](https://apiopscycles.com/pt/roles/capability-owner.md) (core): Responsável pela visão, valor, prioridades, ciclo de vida e reutilização da capacidade junto dos utilizadores. - [Responsável por documentação e DevRel](https://apiopscycles.com/pt/roles/api-devrel-specialist.md) (core): Responsável por conteúdos de onboarding, comunicação com programadores e qualidade da documentação para utilizadores da API. - [Responsável por suporte e operações](https://apiopscycles.com/pt/roles/operations-specialist.md) (core): Representa o suporte em execução, tratamento de incidentes, observabilidade e prontidão operacional da capacidade, API ou automatização. - [Designer API](https://apiopscycles.com/pt/roles/api-designer.md) (consulted): Modela o contrato de interface, o modelo de interação, a consistência e a usabilidade das capacidades expostas. - [Engenheiro de automatização](https://apiopscycles.com/pt/roles/automation-engineer.md) (consulted): Implementa, testa, integra e mantém soluções de automatização e workflows de suporte. - [Especialista em conformidade e jurídico](https://apiopscycles.com/pt/roles/compliance-specialist.md) (consulted): Esclarece requisitos legais, de privacidade, regulamentares e contratuais que afetam a capacidade, API, interface ou automatização. - [Especialista em segurança](https://apiopscycles.com/pt/roles/security-specialist.md) (consulted): Garante que os riscos de segurança, controlos e fronteiras de confiança são tratados ao longo de todo o ciclo de vida. - [Gestor de parceiros ou fornecedores](https://apiopscycles.com/pt/roles/partner-specialist.md) (consulted): Coordena relações com parceiros, fornecedores ou prestadores externos que influenciam a estratégia e entrega da capacidade ou API. - [Responsável de negócio](https://apiopscycles.com/pt/roles/business-owner.md) (consulted): Representa os objetivos de negócio, o financiamento e os resultados esperados da iniciativa de capacidade, API ou automatização. ## Cycle-specific guidance - [Ciclo de Produto de Capacidades](https://apiopscycles.com/pt/cycles/capability-productization-cycle/stations/api-consumer-experience.md) - [Ciclo de Produto de API](https://apiopscycles.com/pt/cycles/api-productization-cycle/stations/api-consumer-experience.md) - [Ciclo de Produto de Integração](https://apiopscycles.com/pt/cycles/integration-productization-cycle/stations/api-consumer-experience.md) - [Ciclo de Automação](https://apiopscycles.com/pt/cycles/automation-cycle/stations/api-consumer-experience.md)