Mini curso - API Integration para Product Managers #2

Os 4 pilares do gerenciamento de API

Na última edição falamos o que esperamos, do ponto de vista de Produto, saber sobre API e os cenários de aplicação dessa interface, do seu produto com outras aplicações e/ou com o mundo. Hoje nosso objetivo é falar sobre alguns dos principais pilares para que sua API seja eficiente e relevante.

No mundo dinâmico do desenvolvimento de produtos, o gerenciamento de APIs desempenha um papel crucial ao facilitar a eficiente utilização dessas interfaces essenciais. Compreender algumas ferramentas que compõem o gerenciamento de APIs é fundamental para qualquer Product Manager que deseje otimizar o processo de integração técnica.

O gerenciamento de APIs abrange uma gama de ferramentas/componentes que colaboram para garantir a operação contínua e eficaz das APIs.

São eles:

API Gateway - Pontos de entrada que atuam como um intermediário entre aplicativos clientes e serviços de backend, controlando o tráfego, aplicando políticas de segurança e otimizando o desempenho. Assim, facilitam o controle de acesso, segurança e gerenciamento de tráfego para as APIs.

API Manager - É uma plataforma que oferece recursos adicionais, como gerenciamento de ciclo de vida de API, portal do desenvolvedor e análise de tráfego. Aqui o seu produto já deve estar com certo grau de maturidade

Microserviços - são uma arquitetura de desenvolvimento de software em que um aplicativo é composto por pequenos serviços independentes que se comunicam por meio de APIs. Enquanto as APIs são as interfaces de comunicação, os microsserviços são os componentes de software que executam tarefas específicas.

💡 Lembrando que a parte técnica com mais nível de profundidade vai ficar concentrado no mini curso do Jefferson, na parte de Developer aqui da nossa newsletter. Link abaixo:

Algumas dessas ferramentas colaboram diretamente com alguns dos pilares fundamentais do gerenciamento de APIs:

1 ) Disponibilidade e Alta Escala

Capacidade dessa interface estar operacional e acessível para os usuários durante o tempo em que é esperado que esteja funcionando. Em outras palavras, uma API disponível está pronta para receber e processar solicitações conforme necessário, sem interrupções não planejadas ou tempo de inatividade significativo.

Ou seja, sabe aquele jogo de futebol, minutos finais e tu precisa passar a bola pra alguém? Esse cara tem que receber a bola e processar com sucesso (esperamos) certo?

Aspectos da Disponibilidade de uma API:

• Tempo de Funcionamento: Medida do tempo durante o qual a API está operacional e pode atender às solicitações dos usuários. Num mundo ideal, isso significa que a API está disponível 24 horas por dia, 7 dias por semana (24/7), com um nível baixo de exceções para manutenção programada.

• Resiliência: Capacidade da API de lidar com falhas e interrupções sem comprometer sua funcionalidade geral. Isso inclui a capacidade de recuperação rápida de falhas e o uso de práticas de redundância para manter a continuidade do serviço.

Já a escalabilidade está relacionada à disponibilidade de uma API devido a habilidade programada de lidar com um aumento na demanda de usuários ou volume de tráfego sem comprometer o desempenho ou a disponibilidade. Existem dois principais aspectos de escalabilidade relacionados à disponibilidade:

• Escalabilidade Vertical: Capacidade de uma única instância da API aumentar sua capacidade de processamento e memória para lidar com mais solicitações. Isso pode envolver a adição de recursos adicionais a um servidor existente.

• Escalabilidade Horizontal: Envolve adicionar mais instâncias da API (escalabilidade horizontal) para distribuir a carga entre vários servidores. Isso permite que a API continue a operar sem problemas, mesmo quando o volume de tráfego aumenta substancialmente.

2 ) Suporte e Documentação

O suporte eficaz é essencial para facilitar a integração e resolver problemas rápido. Além de oferecer suporte técnico direto, uma documentação clara e abrangente desempenha um papel crucial. Na próxima edição, vamos explorar a importância da documentação na integração de APIs, fornecendo dicas e melhores práticas para criar documentação que realmente ajude os desenvolvedores.

3 ) Confiabilidade

Capacidade de funcionar de forma consistente, previsível e sem falhas durante o uso normal e esperado. Em termos mais técnicos, pode ser definida como a habilidade da API de manter suas operações de maneira estável e sem interrupções ao longo do tempo.

Aspectos da Confiabilidade de uma API:

• Disponibilidade (já destacado também no item 1 dessa lista, lembra?!): Uma API confiável deve estar disponível para os usuários sempre que necessária, com um tempo de inatividade mínimo. Isso implica em uma arquitetura robusta que suporte alta disponibilidade e redundância para lidar com falhas de hardware, atualizações de software, picos de tráfego e outros eventos adversos.

• Desempenho: A API deve responder de forma rápida e eficiente às solicitações dos usuários, sem degradação significativa na velocidade de resposta mesmo sob carga pesada. Isso inclui a otimização de consultas e o uso eficaz de recursos para manter tempos de resposta baixos.

• Consistência: A API deve retornar resultados consistentes para uma mesma requisição ao longo do tempo e sob diferentes condições de carga. Isso garante que os usuários possam confiar nos dados e funcionalidades fornecidos pela API em todas as situações.

• Monitoramento e Manutenção: Uma boa prática para garantir a confiabilidade é implementar sistemas de monitoramento contínuo que alertem sobre problemas antes que eles afetem os usuários finais. Além disso, é essencial realizar manutenções preventivas e atualizações de forma planejada para minimizar interrupções.

• Tratamento de Erros: A API deve ser capaz de lidar adequadamente com erros e exceções, fornecendo mensagens de erro claras e orientações para os desenvolvedores sobre como resolver problemas comuns.

Segurança

Proteger as APIs contra ameaças externas e internas é imperativo. Isso envolve a implementação de práticas de segurança robustas, como autenticação, autorização e criptografia, para garantir que apenas usuários autorizados tenham acesso aos recursos e que os dados sejam protegidos contra vazamentos ou manipulações não autorizadas. Alguns desses conceitos estão aprofundados aqui e também no ebook:

Referências

• https://medium.com/appfoster/exploring-api-management-best-practices-for-maximum-efficiency-c0825f45b9d7

• https://www.targetso.com/2023/09/28/api-management/

• https://apim.docs.wso2.com/en/latest/design/design-api-overview/

---

Dominar esses pilares não apenas fortalece a infraestrutura de APIs, mas também capacita os Product Managers a liderar com eficácia equipes de desenvolvimento. Ao focar na disponibilidade, suporte, confiabilidade e segurança, os PMs podem otimizar processos, reduzir custos operacionais e entregar produtos mais robustos e seguros aos clientes.

E para te ajudar nessa jornada, em breve teremos novos episódios, tanto na categoria Tecnologia, como aqui, na de Produto. Veja uma amostra:

• [x] API Integration para Product Managers

• [x] Ferramentas e boas práticas;

• [ ] Documentação;

• [ ] O valor das integrações;

• [ ] Metricas e impacto;

💡 Caso se interessar acompanhe também o “API #01: Introdução” onde abordamos a parte ainda mais técnica do assunto.