Analytics
8
min de leitura
7 de julho de 2020

Como ter uma integração 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

Publicamos anteriormente algumas informações e diretrizes que são recomendadas por nossa equipe de Developer Experience aqui na Sensedia, e hoje vamos seguir as mesmas diretrizes e apresentar a você algumas ações importantes para garantir a qualidade de uso e saúde das APIs e integrações.

- Assegure-se de que você 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 totalmente como realizar chamadas de sucesso e tenha a melhor compreensão de uso.

Ele saberá o processo de autenticação necessária, como realizar as chamadas corretamente nas APIs, como identificar os retornos e várias outras informações pertinentes ao desenvolvimento e uso.

- Acompanhe as chamadas que estão ocorrendo em sua integração diariamente, seja através de registros, métricas ou alertas automáticos;

Desta 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.

Fique atento! Requests com erros de fato ocorrem, mas o importante é você conseguir identificar e prevenir para que não gere um impacto (seja a quem está utilizando a API quanto ao seu backend e negócio).

– 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á-lo corretamente será mais fácil de compreensão e identificação de erros mais rapidamente.

- Identifique os maiores infratores, tanto o APP/desenvolvedor que está causando o erro e também a razão para este cenário;

Com isso, você conseguirá ter 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 devidos a uma má compreensão da usabilidade do API ou mesmo a uma sobrecarga no backend.

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

Muitas vezes focar somente 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 o seu desenvolvedor questões relacionadas ao negócio, fluxos e melhores formas e práticas que pode-se usar as APIs. Com certeza isso irá apoiá-lo em compreender todos os cenários de uso.

- Tenha contato próximo com seus 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 de ambos os lados fácil e rápida? Este é um ponto bem importante, pois tendo esta proximidade, será mais ágil você comunicar falhas e melhorias de integração e também ter um apoio em uma visão externa de uso.

- Receba Feedback;

Como comentado acima, ter uma aproximação com os parceiros/desenvolvedores que utilizam a API é de extrema importância, tendo em vista que são eles que estão no dia-a-dia na usabilidade destas chamadas e terão uma visão que muitas vezes a pessoa que desenvolveu/criou não teve (uma visão externa é sempre boa!)

Peça feedbacks constantes à eles, nesta ação poderão surgir muitas opiniões de melhorias e até indicativo de pontos fortes de sua API.

- Busque sempre melhorias

Não é porque seu API já está em produção e sendo utilizado que as melhorias não podem surgir com o tempo.

A combinação das ações mencionadas acima pode mostrar se elas têm problemas que podem ser melhorados em termos de fluxo e até mesmo de usabilidade.

Se você identificou pontos que podem tornar o uso mais fácil e claro em logs, acompanhamento ou contato com seu desenvolvedor, implemente-os em suas APIs.

Esta 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. Então, você está ciente destes itens? Você coloca tais ações em prática dentro de sua empresa e de suas APIs?

Compartilhe conosco se houver algo mais que você acha importante prestar atenção a fim de garantir o uso saudável e de qualidade das APIs!

Obrigado pela leitura!