Tenho uma API, que faço agora?

Uma API só terá utilidade se poder fornecer integrações.

As integrações poderão ser públicas, onde outras aplicações poderão consumir a API ou privadas, onde somente aplicações conhecidas e autorizadas poderão usufruir de informações.

De qualquer maneira, para que as integrações ocorram, uma boa experiência de consumo resultará em uma maior adesão e menos atritos entre diferentes times de desenvolvimento.

Considero quatro componentes essenciais para essa aderência:
Consumo, onboarding, execução e suporte.

Na imagem abaixo podemos observar alguns itens que cada uma delas compõe:

AX - Quatro componente de API Experience

Consumo

 Traduzindo em outros termos Developer Experience, é a mais popular hoje. Um consumidor de uma API é um desenvolvedor que usa a API em seu código.
Portanto é um fator importante para determinar a experiencia da API.
Mas o que é importante para a uma boa experiência? Na imagem podemos verificar quatro itens que considerar importante, mas poderíamos listar outros como uso de API em uma linguagem de programação escolhida, usar em conjunto com outras APIs, etc…

Onboarding

Primeiro contato do Dev com a API.
Devemos fornecer todo tipo de material para a adesão a API. Tutoriais, SDKs, acesso ao portal de APIs, cadastro, são algumas das formas de ambientar o Dev para a integração ser mais tranquila possível.
Evitando ter que requisitar algum tipo de suporte para realizar a integração sem intervenção da empresa fornecedora das APIs.

Suporte

 Erros são inevitáveis. Tanto na API para quem utiliza dela.
A melhor forma de relacionamento com o Dev é possuir facilitadores para relatar erros, procurar por erros conhecidos a fim de sana-los de forma automática.
Também é necessário uma constante validação e verificação dos ambientes das APIs, minimizando e comunicando Devs e parceiros sobre correções.

Execução

Tem relação de garantir a qualidade da minha API que está nos ambientes (ex. testes (Sandbox) e Produção).
Acompanhar o tempo de resposta das chamadas. Permitir atualizar futuras versões com o mínimo de impacto com a versão corrente. Atualização constante de documentações, tutoriais e do portal.

Para garantir o sucesso de integração de utilização, devemos considerar que somos um braço do cliente, uma extensão para entrega de valores do seu cliente a outros clientes.

Por isso, devemos auxilia-los sempre que necessário. Possuindo um time de suporte, buscando otimizações das chamadas de API. Quanto menos impacto, teremos menos atrito, mais aderência e integrações.

Deixe um comentário