Developer Experience: evolução das APIs através dos dados

Certamente, você já ouviu um termo comum quando o assunto é APIs, que é Developer Experience (DX). Ele lembra um pouco o UX, e isso não é por acaso, pois ambos se referem a experiências apropriadas para uma pessoa específica.

No caso do DX, obviamente, o foco é o desenvolvedor e, como em qualquer processo de criação de experiência, algumas ferramentas são necessárias para permitir que sua API evolua na direção certa, garantindo a melhor experiência para você.

O escopo das ferramentas é variado e pode incluir análises simples ou estruturas mais complexas, como a Inteligência Artificial. Hoje, vamos mostrar algumas sugestões de como desenvolver uma API baseada na análise de dados. Para começar, é sempre interessante contar com uma ferramenta que possa fornecer esses dados.

No caso da API Management Platform da Sensedia, utilizamos o Kibana. Além do Kibana, uma característica importante para esse tipo de análise é a característica Trace da ferramenta. Caso você não esteja familiarizado com ela, é a capacidade de analisar em detalhes todas as solicitações que ocorrem no Gateway, como mostrado na imagem abaixo.

Com essa análise Kibana, é fácil obter informações e insights sobre melhorias de API ou mesmo boas práticas de consumo para seu desenvolvedor. De agora em diante, mostraremos algumas situações observadas na Sensedia, em casos com nossos clientes.

Nessas ocasiões, foi possível obter insights de como melhorar uma API para seu respectivo público-alvo.

Quer conhecer a plataforma de API Management da Sensedia? Clique aqui e saiba mais!

Caso 1: validação de aplicação 404

O primeiro passo para começar a melhorar sua API, com base nos dados que sua ferramenta de Analytics e API Management pode oferecer, é investigar todas as solicitações 404 que chegam ao seu Gateway.

Imagine que você tem as características do cliente, mas o display está em inglês.

GET http://miurl/v1/clients

Ao trabalhar no mercado brasileiro, muitas das solicitações com respostas 404 serão de acomodação visual, ou seja, seus usuários estarão fazendo a solicitação

GET http://miurl/v1/clients

Com essa observação feita através dos dados recebidos, é interessante implementar o seguinte retorno para ajudar a experiência do usuário:

‍

{

"Erro": "não encontrado";

"Mensagem": "Não Encontrado". Você quis dizer '/clientes'"?";

"Status_code": 404

}

‍

Com essa mudança, validando os erros mais comuns de seus usuários, é possível melhorar a experiência e evitar que o desenvolvedor tenha que retornar ao portal do desenvolvedor para validar novamente o recurso correto a ser executado. Isso permite que solicitações bem-sucedidas aconteçam rapidamente.

Caso 2: uso de um conjunto de chaves igual à produção

Algo muito interessante, que pode ser verificado nas solicitações feitas em seu portal de desenvolvimento, é o número de possíveis clientes que são convertidos para produção, ou seja, o volume de Access Tokens criados para produção promovidos após um período experimental com suas APIs.

Ao comparar os dados de conversão das empresas que utilizaram as mesmas chaves para sandbox e produção com aquelas que tiveram um processo mais burocrático com a geração de novas chaves, há uma diferença considerável. Assim, mais uma vez, os dados analíticos do Kibana foram muito importantes. No entanto, para utilizar essa facilidade de movimentação entre ambientes nas fichas, é necessário que sua ferramenta de API Management tenha essa característica. Caso contrário, o trabalho será grande ou mesmo inviável.

Caso 3: melhoria do backend durante os horários de pico

Nesse terceiro caso, a abordagem de análise é o próprio backend, para que você possa proporcionar uma melhor experiência com melhores tempos de resposta para seu público de desenvolvedores.

Como podemos ver no gráfico abaixo, há dois grandes picos de latência backend no período de tempo descrito. Nesse caso, há duas APIs - uma que é muito constante e outra que é oscilante.

Embora este exemplo apresente picos muito irrelevantes, já que a latência máxima atingiu 800 milissegundos, é um bom caso para demonstrar como essa análise é realizada.

Quando há picos na latência do backend, é necessário ajustar o comportamento da API com interceptores, que medirão e controlarão o Spike Arrest (número de pedidos de pico) em seu backend. Além disso, uma prática muito interessante para evitar que a solicitação chegue a seu backend é o uso do sistema de cache de sua ferramenta de API Management .

Dessa forma, o desenvolvedor terá sempre respostas mais rápidas e precisas, permitindo o desenvolvimento da aplicação que utilizará sua API de forma muito mais eficiente e tornando sua API mais interessante.

Caso 4: análise de recursos com mais erros

Este caso é muito interessante e é semelhante à análise do primeiro caso, mas tem uma característica mais interna do que orientar o desenvolvedor a fazer o pedido corretamente.

A análise de erros pode sempre ser um diferencial, mesmo em sociedades específicas, pois, caso seu parceiro esteja sendo bloqueado por erros 429 (número de solicitações excedido), você poderá oferecer um plano melhor a esse parceiro e obter mais renda com sua API.

É claro que, além dos benefícios financeiros, você pode observar os principais tipos de erro que ocorrem em suas requests de API, tais como formato de data errado.

Imagine que sua API tem uma característica GET na qual um dos parâmetros é a data de início. Você certamente especificará a data em que seu backend aceita em sua documentação da API. Contudo, na construção de uma aplicação, pode ser que os desenvolvedores não percebam o tipo de data oferecida por sua API.

Assim, um dos benefícios que você pode dar ao seu desenvolvedor é compreender os tipos de data mais amplamente utilizados ao enviar aplicações para seu backend e seguir em frente para apoiá-lo.

Com tais mudanças, você garantirá que mais pessoas possam usar sua API mais fácil e rapidamente, que é o objetivo quando se trata de DX.

Caso 5: suporte pró-ativo para consumidores de API

O último caso tratará do suporte pró-ativo aos usuários de sua API. Este exemplo é muito delicado, mas muito importante, pois os desenvolvedores são pessoas, e as pessoas podem sempre ser ajudadas com um toque humano.

Quando você é capaz de perceber erros comuns de compreensão na API e no uso?

Através dos Tokens de Acesso, é possível segmentar as pessoas que estão cometendo esses erros em sua API. Ele também permite que você envie e-mails a esses desenvolvedores, oferecendo uma ajuda pró-ativa para usar sua API e um entendimento comercial.

Esta ajuda é essencial para conseguir desenvolvedores ainda mais engajados, que podem estar enfrentando dificuldades para usar sua API. Esta ação visa criar um relacionamento com os consumidores de sua API, para proporcionar não apenas melhores resultados, mas também uma experiência mais ampla e uma variação nos usos.

Suas APIs em constante evolução

Contar com APIs se tornou essencial no crescimento ágil e eficiente dos negócios, mas dispor de recursos que otimizem sua performance e consumo é um passo ainda mais importante nas estratégias das empresas. Isso garante que todo o potencial das APIs seja aproveitado e facilita as rotinas de todo o seu ecossistema. APIs e dados atuam de forma sinérgica nesse contexto, levando visibilidade e previsibilidade à aceleração digital.

Entenda como Developer Experience pode ajudar a sua empresa a crescer ainda mais. É só clicar aqui para conferir o blogpost!

‍