Analytics
8
min de leitura
7 de julho de 2020

Como ter uma integração de API saudável

Luciana Bandeira
Developer Experience
Ajudo desenvolvedores no onboarding e nas melhores práticas de APIs para garantir a melhor Developer Experience. No meu tempo livre me dedico a livros, pesquisar (e degustar) sobremesas e sou apaixonada por viajar.
Mais sobre o autor

Cuidar de todo o ciclo de vida de APIs é uma das grandes especialidades da Sensedia, desde a sua criação até a aposentadoria. Aqui no nosso blog você já viu como dar a devida atenção a Developer Experience possibilita que suas APIs sejam consumidas da melhor forma possível. Hoje vamos mostrar 8 ações importantes para garantir a qualidade de uso e saúde das APIs e integrações.

1. Tenha um Portal do Desenvolvedor com informações sobre o guia de desenvolvimento e diretrizes de uso

Este caso é muito importante para que o seu desenvolvedor saiba realizar chamadas de sucesso e tenha a melhor compreensão de uso. Ele saberá o processo de autenticação necessário, como realizar as chamadas corretamente nas APIs, como identificar os retornos e todas informações pertinentes ao desenvolvimento e uso.


2. Acompanhe as chamadas da sua integração diariamente, seja através de registros, métricas ou alertas automáticos

Dessa forma, será possível identificar quando um desenvolvedor está com muitos erros, quando o backend está no ponto de estrangulamento e outros cenários importantes para agir e corrigir. Atenção: requests com erros de fato ocorrem, mas o importante é você conseguir identificar e prevenir para que não gerem um impacto - seja em quem está utilizando a API ou no seu backend e negócio.


3. Utilize corretamente os retornos oferecidos na API

Padronize seus retornos de chamadas. O uso dos HTTP Status tem seus padrões de códigos conhecidos mundialmente e utilizá-los corretamente será mais fácil para compreensão e identificação de erros mais rapidamente.

4. Identifique os maiores infratores, tanto o APP/desenvolvedor que está causando o erro quanto a razão para esse cenário

Com isso, você conseguirá tomar medidas e prevenir suas APIs e serviços de um aumento de erro e sobrecarga indevida, além de conseguir identificar possíveis falhas de compreensão do desenvolvedor ou possíveis melhorias de usabilidade e clareza da sua integração. Muitas vezes, os maiores infratores dos erros que ocorreram são originados por uma má compreensão da usabilidade da API ou mesmo por uma sobrecarga no backend.


5. Tenha uma visão técnica e de negócio

Normalmente, focar apenas nas questões técnicas das APIs não será o suficiente para tornar sua API clara e fácil de usar. Você pode compartilhar com seu desenvolvedor questões relacionadas ao negócio, fluxos e melhores formas e práticas de utilização de APIs. Com certeza isso vai contribuir na compreensão de todos os cenários de uso.

6. Tenha contato próximo com parceiros e desenvolvedores externos

Você tem um canal de atendimento e comunicação com os seus parceiros? É próximo deles para que tenham uma comunicação bilateral fácil e rápida? Esse é um ponto extremamente importante - tendo essa proximidade, você comunicará falhas e melhorias de integração com mais agilidade e também terá apoio em uma visão externa de uso.

7. Receba feedback

Como comentado anteriormente, ter proximidade com os parceiros/desenvolvedores que utilizam a API é essencial, tendo em vista que estão diariamente lidando com a usabilidade dessas chamadas, o que lhes proporciona uma visão diferente (e repleta de insights) em relação à visão do responsável pelo desenvolvimento/criação. Peça feedbacks constantes a eles, pois poderão surgir muitas opiniões de melhorias e até indicativos de pontos fortes de sua API.


8. Busque sempre melhorias

Não é porque sua API já está em produção e sendo utilizada que as melhorias não podem surgir com o tempo. A combinação das ações mencionadas acima pode mostrar se suas APIs têm problemas que podem ser melhorados em termos de fluxo e até mesmo usabilidade. Se você identificou pontos que podem tornar o uso mais fácil e claro em logs, acompanhamento ou contato com seu desenvolvedor, implemente em suas APIs. Essa melhoria também é válida para o Portal do Desenvolvedor - a constante evolução da documentação disponível tornará todo o processo organizado e fácil.


As melhores APIs para o seu negócio

Quais dessas ações já fazem parte da sua rotina? A Sensedia pode apoiar a sua empresa na estruturação e execução da melhor estratégia de APIs para alavancar o seu negócio! Entre em contato com a gente para saber mais!


Obrigado pela leitura!