Como saber se a API está realmente contribuindo para o trabalho do desenvolvedor? Para responder essa pergunta, levantamos 7 pontos que devem ser observados com atenção, a fim de, verificar a usabilidade da API e consequentemente o seu sucesso.
Primeiro, vamos olhar para a experiência do usuário (UX) em geral. O UX considera a experiência geral que uma pessoa tem com um aplicativo móvel, site ou outra plataforma digital. Essa experiência pode ser positiva ou negativa, tudo vai depender do quão fácil é a interação homem-máquina.
Proporcionar uma experiência de fácil utilização, para quem for utilizar aquela informação ou aplicação deve ser regra, mesmo que a pessoa do outro lado seja um desenvolvedor experiente. Lembre-se que, o desenvolvedor pode ser o usuário final ou mesmo um intermediário nesse processo.
Confira este vídeo da Nordic API e entenda a importância de se desenhar uma experiência fluida ao construir uma API:
Resolvemos listar 7 Dicas que você irá aprender ao assistir o vídeo acima e são elas:
1. Estrutura da API
Quanto mais complexa for a estrutura da API, mais os desenvolvedores precisarão dedicar tempo e esforço para criar uma funcionalidade ou aplicação através daquela API. Isso não é de todo ruim, já que pode representar uma API mais seleta e com mais funcionalidades.
O problema é quando essa complexidade se torna uma barreira para a criação, configuração e finalização da aplicação. Nesses casos, o ideal é agregar intuitividade a estrutura da API para tornar a usabilidade mais fácil e gerar uma experiência positiva ao usuário, principalmente se você tiver como objetivo a escalabilidade dessa API.
2. Navegação da API
A navegação é outro cuidado importante que deve ser tomado. Além da intuitividade, que ajuda a resolver grande parte dos problemas de estruturas complexas, a boa navegação pode ser agregada facilitando o acesso e movimento dos dados dentro do sistema, ou seja, como os dados são movidos de uma lado para outro, seguindo qual comportamento?
3. Guia de usabilidade da API
Muitos problemas de usabilidade podem ser resolvidos com um documento (confira 4 dicas para criar uma boa documentação) que sirva de guia para o usuário. Por se tratar de um protocolo de livre configuração, se assim ela for programada, é importante disponibilizar um guia prático para solucionar dúvidas e ajudar o usuário a utilizar a API com maior eficiência. Focar na documentação também é um item importante.
4. Testes frequentes
O desenvolvedor deve, frequentemente, utilizar a API como um usuário comum e considerar todos os fatores descritos nesse post para medir a usabilidade dela. É preciso enxergar e sentir as dificuldades reais do usuário para identificar erros e barreiras que impeçam a geração de uma boa experiência de uso.
5. Identificação e correção de erros
Como a API estabelece uma comunicação entre dois sistemas, é muito importante focar na detecção de falhas. Bugs podem representar um grande problema ao usuário impedindo-o de executar tarefas simples na API. Para resolver esse problema, os testes frequentes e feedbacks dos usuários podem ser muito úteis.
6. Vocabulário utilizado na API
Muitos aplicativos utilizam nomenclaturas de difícil compreensão para os usuários comuns. Só os desenvolvedores de sistemas entendem melhor. A menos que a sua API seja desenvolvida para um público específico de programadores, o recomendável é utilizar um vocabulário mais simples e entendível por qualquer pessoa.
7. Experiências geradas
A experiência vai muito além do primeiro contato com a API. É preciso pensar em continuidade. Gerar experiência é um fator importante para todas as etapas (contato, conhecimento, fase de estruturação, testes de navegação e usabilidade, recursos disponíveis, funcionalidades, etc.).
As boas experiências geradas em todas as fazes de uso aumentam a probabilidade de um sucesso prolongado para a API.
Conclusão
Ao projetar uma API, você deve se lembrar constantemente que se a sua API for mal concebido, mal documentada ou mal suportada, ninguém vai usá-la, a menos que eles sejam forçados a isso, o que não trará muito engajamento mesmo assim.
Antes de projetar uma experiência para desenvolver uma API, primeiro devemos responder:
- O que estamos projetando?
- Por que estamos projetando?
- Com quais limitações devemos ter cuidado?
Quem está Projetando uma API deve se concentrar em:
- funcionalidade;
- usabilidade;
- experiência do desenvolvedor.
A usabilidade deve ser medida por meio de uma auditoria da API e, em seguida, acompanhando as ações dos seus usuários, ou seja, queremos saber o que os desenvolvedores estão fazendo. Foque no seguinte, primeiro a API e depois o device (aproveite para ler o post) pois, é uma boa maneira que você possuiu para se concentrar nas principais funcionalidades da API sem se preocupar com a questão do front. E você trás para essa conversar o desenvolvedor que irá utilizar essa API.
Ficando atento a todos esses fatores, o desenvolvedor pode elaborar uma estrutura de análise para monitorar e medir a usabilidade API em parceria com os usuários. Através dos resultados e feedbacks dos usuários, fica mais fácil realizar uma estatística apontando os pontos fracos e fortes da aplicação.
E você, como mede a usabilidade da sua API? Conta para a gente nos comentários!
Post inspirado por Nordic API
