Como criar uma estratégia de gerenciamento de API?

Por que criar uma estratégia de gerenciamento de API?

Em termos gerais, uma API (Application Programming Interface) é um módulo de código que executa uma tarefa específica e define um conjunto de protocolos que podem ser usados por outros para executar essa tarefa. No mundo de hoje, porém, as APIs tornaram-se mais do que meras ferramentas: existe agora uma vasta e crescente economia de código que pode ser facilmente inserido em um aplicativo para executar uma tarefa discreta. Uma estratégia eficaz de gerenciamento de API aprimora a experiência do desenvolvedor, eleva a qualidade do software, reduz as despesas de desenvolvimento, permite a escalabilidade do sistema e fortalece as medidas de segurança.

Se a sua organização gerencia uma API e está pensando em disponibilizá-la ao público, seja como uma estratégia de monetização ou de reconhecimento da marca, é vital garantir que a API seja bem gerenciada. Os usuários fora da sua organização esperam uma boa experiência e você deve estar preparado para oferecer essa experiência por meio da sua API.

É aqui que entra em jogo uma estratégia sólida de gerenciamento de API . Existem três componentes principais para montar um plano estratégico de gerenciamento de API eficaz: identificar as áreas de gerenciamento eficaz de API, decidir se você precisa de uma ferramenta de gerenciamento de API – e que tipo de ferramenta você deve usar, e selecionar essa ferramenta.

Etapa um: identificar os recursos do gerenciamento eficaz de APIs

O gerenciamento eficaz da API envolve a supervisão de todos os aspectos da API que sua empresa ou usuários externos utilizarão. Isso inclui desempenho, segurança, autorização, documentação, análise e acessibilidade.

1. Gateway / Acesso Um gateway de API é a camada entre o público e seus serviços de back-end. É aqui que as solicitações recebidas serão interceptadas e roteadas para as partes corretas da sua API. Você deve utilizar cache, limitação e otimização de taxa e agrupamento de respostas para garantir velocidade e consistência para seus usuários.

   
   

2. Metas de desempenho Disponibilidade, velocidade e confiabilidade são aspectos cruciais de qualquer API voltada ao público. Você deve ser capaz de garantir um certo tempo de atividade para seus usuários e proteger e recuperar os dados do usuário em caso de falha ou tempo de inatividade. Identifique os objetivos da sua API.

   
   

3. Tipos de segurança/autorização A segurança é importante não apenas para proteger seu servidor, mas também para proteger dados confidenciais do cliente. Sua estratégia de API deve incluir segurança por uma chave de API, certificado de cliente ou estratégia OAuth. Mesmo que sua API forneça dados que não sejam privados, as solicitações de rede que ela trata ainda deverão ser protegidas.

   
   

4. Autenticação/Gerenciamento de Políticas Após a autorização, a autenticação e o gerenciamento de políticas são importantes para estabelecer funções de usuário e acesso de equipe e gerenciar identidades e privilégios. Isso aumenta a segurança limitando quais recursos estão disponíveis para quais usuários e melhora a organização de seus usuários.

   
   

5. Portal do Desenvolvedor/Documentação Um portal intuitivo do desenvolvedor e uma boa documentação também são cruciais para um bom gerenciamento de API. Seu portal do desenvolvedor deve incluir um sandbox onde os desenvolvedores podem testar seus endpoints, um catálogo de APIs descrevendo todas as APIs disponíveis em sua organização e uma documentação clara e pesquisável com guias para começar e executar tarefas comuns.

   
   

6. Análises Suas análises fornecerão informações valiosas sobre como as pessoas estão usando sua API, o que permitirá que você concentre recursos nas áreas que serão mais lucrativas. Além disso, as análises costumam ser úteis para seus usuários.

Etapa dois: considere usar um proxy, agente ou abordagem híbrida

As soluções de gerenciamento de API podem cuidar de uma ou mais dessas tarefas para você. As soluções são fornecidas por meio de proxies, agentes ou abordagens híbridas.

1. Proxies Uma solução de proxy fica entre a API e seus usuários. Os proxies oferecem benefícios como cache para otimizar o desempenho e proteger a API contra picos repentinos de tráfego. No entanto, um proxy pode potencialmente aumentar os custos e as preocupações relacionadas com a privacidade e a latência. Exemplos de tais implementações de proxy incluem Apigee, Mashape e Mashery.

   
   

2. Agentes Agentes são plug-ins que funcionam perfeitamente junto com o seu servidor. Ao contrário dos proxies, eles não interferem nas chamadas de API. Consequentemente, não introduzem atrasos na rede ou dependências externas. No entanto, implementar recursos como cache pode ser um desafio. Um exemplo desse tipo de implementação é o 3scale.

   
   

3. Híbrido Para obter o benefício de ambas as implementações, você pode usar um agente e um proxy combinados. Por exemplo, você pode optar por um proxy para lidar com o cache enquanto usa um agente para fins de autenticação. Empresas como Apigee e 3scale estão fazendo a transição para soluções híbridas.

Etapa três: determine qual ferramenta é melhor para seu gerenciamento de API

Algumas das principais ferramentas de gerenciamento de API incluem o seguinte:

• Mulesoft Anypoint: Uma plataforma baseada em nuvem que pode lidar com todos os aspectos do gerenciamento de API para você.
• Apigee: plataforma nativa de gerenciamento de APIs do Google que pode ser usada para criar, gerenciar e proteger APIs.
• IBM API Connect: desenvolvido para suportar o ciclo de vida do DevOps. Integra-se com Selenium e Jenkins para teste.
• 3Scale: sistema de gerenciamento de APIs da RedHat que oferece soluções flexíveis para empacotar suas APIs.

Determinar qual solução é a certa para você exigirá uma avaliação de seu orçamento, dos recursos existentes (ou seja, das pessoas que você tem disponíveis internamente para trabalhar nisso), de suas necessidades e da escala prevista de sua API.

Posso gerenciar minhas APIs internamente ou devo contratar ajuda externa?

Isso depende de você. Se você tiver uma organização grande o suficiente para dedicar uma equipe ao gerenciamento de API, poderá cuidar disso sozinho. Mas o gerenciamento de APIs é uma tarefa complexa e especializada e não deve ser simplesmente transferida para engenheiros já sobrecarregados em outras áreas da sua empresa.