Compartilhar:
){kind=small}
Lorna é engenheira de software e tem um vício incurável por escrever em blogs. Ela tenta domar as palavras e o código na mesma medida.
O que faz com que um produto de API seja bem-sucedido?
Tempo de leitura: 4 minutos
Além de dedicarmos nosso tempo à criação de APIs incríveis para nossos usuários, também participamos de eventos com outros desenvolvedores de APIs.
Em outubro, estivemos no APItheDocs em Amsterdã para apresentar algumas palestras nossas. Uma palestra que realmente gostamos foi a intitulada “O que torna um produto de API bem-sucedido?”, ministrada por Anthony Roux, então decidimos compartilhar um resumo da palestra.
Se você estiver realmente interessado, pode assistir ao Video da palestra:
A palestra de Anthony abordou uma série de pontos (oito no total) que ele considerou importantes para o sucesso de uma API como produto. Achamos que alguns deles realmente se alinhavam ao trabalho que já estamos realizando, enquanto outros nos deram motivos para refletir sobre aspectos que adoraríamos melhorar. No geral, foi uma excelente combinação de pontos.
Ao garantir que os clientes em potencial tenham acesso a toda a documentação necessária para trabalhar com o aplicativo, você pode aumentar a confiança deles na escolha da sua API como solução.
Toda a nossa documentação de referência da API também está disponível como especificações OpenAPI, e esperamos que isso ajude os desenvolvedores a terem mais clareza tanto ao explorar nossas ofertas quanto ao realizar a integração e a manutenção das Applications que criam.
Incluir páginas de status, preços e termos e condições na categoria “transparência é essencial” é claramente fundamental para o trabalho na Amadeus, e também o é para nós.
Temos muito orgulho de nossa documentação premiada* e do nosso portal para desenvolvedores https://developer.nexmo.com/ Combinamos documentos de referência da API com diversos trechos de código para uma variedade de pilhas tecnológicas, guias de alto nível e também alguns tutoriais mais detalhados para acompanhar, passo a passo, o desenvolvimento de uma aplicação específica.
*Nós realmente ganhamos prêmios! Veja se consegue nos identificar aqui https://pronovix.com/blog/devportal-awards-2019
Torne o processo de cadastro bem fácil e rápido para que o usuário possa começar a explorar o site o mais rápido possível.
O conselho do Anthony de adiar ao máximo a coleta de dados foi muito valioso. Isso também me fez pensar no único e inigualável @cbetta, de outra excelente palestra que assisti no ano passado: “Certifique-se de se cadastrar para usar sua API com frequência!”.
Acompanhar o processo de cadastro e estar atento à experiência do usuário durante esse processo é um elemento fundamental da Experiência do Desenvolvedor.
A “Regra dos Três” de Anthony para a experiência de integração do público-alvo:
3 segundos para entender uma API
30 segundos para criar um Account
3 minutos para fazer a primeira chamada de API
Se ao menos todas as APIs fossem criadas com isso em mente!
Isso foi muito bem feito e gostei da ênfase dada à disponibilização de exemplos de código de código aberto e executáveis.
Mantemos coleções de exemplos de código executável e, à medida que precisamos, os incorporamos à nossa documentação para desenvolvedores — com um link para o código “real” no GitHub. Isso nos ajuda a manter a coleção de exemplos de código e também permite que os desenvolvedores acessem o contexto do código, caso precisem.
Contar com um SDK pode realmente agilizar o trabalho de um desenvolvedor na integração com uma API.
Assim como nós, a Amadeus disponibiliza descrições detalhadas de suas APIs no formato OpenAPI, e Anthony deu ótimas dicas sobre o equilíbrio entre SDKs gerados automaticamente e soluções encantadoras, artesanais e feitas à mão. Com nossas 6 (e uma sétimo não oficial) SDKs, fiquei muito atento a essa seção e foi ótimo ouvir as experiências de outras pessoas que enfrentam problemas semelhantes.
Oferecer um período de teste gratuito limitado a todos os usuários da API é uma ótima maneira de ajudar os desenvolvedores a conhecer melhor o seu serviço.
Pode haver uma cota baixa ou, por exemplo, só permitimos o uso de um pequeno número de números de telefone de teste quando um Account está nessa fase. Muitas vezes, os desenvolvedores não têm acesso ao cartão de crédito da empresa quando estão apenas criando protótipos; portanto, certifique-se de que ter um cartão não seja um requisito para uma pequena experimentação!
Mantenha o modelo de preços simples e ofereça diversas opções de formas de pagamento. O modelo de pagamento por uso funciona bem, especialmente para clientes que podem começar com um volume pequeno e depois crescer.
A seção final aborda um tema que nos é muito caro: o apoio.
Deixe bem claro para os usuários como eles podem entrar em contato com você para obter suporte e como podem entrar em contato com você em geral.
A recomendação enfática de Anthony foi usar plataformas públicas para obter suporte, por exemplo, Stack Overflow, para que, ao responder à pergunta de um usuário, outros usuários possam encontrar a mesma resposta.
Ele também recomendou usar uma seção de perguntas frequentes (FAQ) e atualizá-la regularmente. Isso, juntamente com diversos recursos de documentação, como um mecanismo claro de feedback, ajudará muito a entender como está sendo a experiência do usuário.
Participar de eventos relacionados à nossa área de atuação, bem como simplesmente interagir com os clientes, é realmente importante para nós como equipe; isso contribui para o nosso desenvolvimento profissional e nos coloca em contato com nossos colegas (e são muitos deles, já que somos uma equipe grande por si só!).
Essa palestra foi, sem dúvida, uma das minhas sessões favoritas do APItheDocs. Obrigado, Anthony!