O que é um endpoint de API?

Os endpoints de APIs geralmente são encontrados na documentação de uma API, que é onde os desenvolvedores colocam informações da API, como que tipo de solicitações uma API aceitará e como as solicitações devem ser formatadas. O ideal é que essa documentação também inclua uma lista de todos os endpoints de APIs disponíveis e uma breve descrição de suas funcionalidades.

Em um contexto de API REST (um estilo arquitetônico de software frequentemente usado para aplicações da web), o processo tem a seguinte aparência:

O processo começa quando um cliente de API envia uma solicitação de recurso (chamada de API) para o endpoint da API correspondente. Os endpoints são acessados usando métodos de solicitação HTTP, como POST, GET, PUT, PATCH e DELETE. Esses métodos indicam a ação que o cliente deseja realizar no recurso especificado.

Por exemplo, se um cliente deseja recuperar uma lista de totais de medalhas olímpicas para um determinado ano do banco de dados hipotético Olympicfacts.com, uma solicitação GET é enviada para o seguinte URL de endpoint: 

https://api.olympicfacts.com/v1/{year}

Essa solicitação retornaria uma lista do total de medalhas olímpicas por país. (v1 em nosso endpoint hipotético indica a versão da API, uma prática comum no controle de versões de APIs.) Se o cliente quisesse um total para um país específico em um determinado ano, um identificador seria adicionado ao URL base: 

https://api.olympicfacts.com/v1/year/{id}

Neste exemplo, o identificador {id} é usado para indicar de qual país o cliente deseja receber informações.

Além disso, uma solicitação pode incluir:

• Cabeçalhos: os cabeçalhos podem fornecer informações adicionais sobre a solicitação, como um cabeçalho Aceitar, que especifica os tipos de mídias aceitos
  
  
• Parâmetros: os parâmetros de consulta podem ser adicionados ao URL de base ou ao corpo da solicitação para filtrar ainda mais os critérios de pesquisa ou adicionar outras especificações.
  
  
• Corpo da solicitação: um corpo da solicitação inclui os dados necessários para criar ou modificar um recurso. Por exemplo, se a solicitação for para criar um novo blog (solicitação POST), o conteúdo do novo blog será incluído no corpo da solicitação.
  

Depois que o servidor autentica a solicitação e valida a entrada, ele recupera os dados solicitados e retorna a resposta ao cliente. Muitas organizações usam API Gateways para executar essas funções e gerenciar o fluxo de tráfego de APIs.

Fundamental para qualquer bom design de API é a fase de testes. As aplicações modernas geralmente usam APIs para integrar funções de outros softwares ou são criadas usando arquiteturas de microsserviços (que dependem de APIs para comunicação entre serviços díspares). Testar os endpoints de APIs é essencial para garantir confiabilidade.

Existem opções de testes manuais para APIs e opções de testes que utilizam automação, bem como inúmeras ferramentas e plataformas de testes (tanto de código aberto quanto proprietárias) que as empresas podem utilizar.

Os testes manuais de endpoints de APIs podem ser mais lentos e menos eficientes, mas também mais precisos e personalizados para casos de uso específicos. Testes funcionais seria simplesmente enviar uma solicitação de uma aplicação para garantir que a resposta correta seja dada. Em um exemplo de redes sociais, isso pode significar o envio de uma solicitação para uma nova postagem de um determinado usuário e a verificação para garantir que a postagem retornada seja realmente a correta.

Outros tipos de testes manuais envolvem: 

• enviar muitas solicitações de uma só vez para ver como o servidor lida com a carga de solicitações
  
  
• verificar se a API se integra corretamente a outros serviços
  
  
• determinar a velocidade e o tempo de resposta de uma determinada solicitação
  
  
• fornecer intencionalmente uma solicitação inválida para verificar se a mensagem de erro correta é retornada

Testes automatizados feitos por meio de uma plataforma de gerenciamento de API podem oferecer diversas vantagens:

• reduz a possibilidade de erro humano
  
  
• é mais eficiente na verificação da validade de vários endpoints de APIs
  
  
• pode melhorar a velocidade dos testes podendo reduzir custos a longo prazo, após os sistemas de testes automatizados serem estabelecidos (economizando tempo dos funcionários, por exemplo)
  
  
• Alinha os testes ao longo de protocolos, padrões e permissões uniformes

Em geral, cada um deve retornar a resposta pretendida, em termos de formato, dados retornados e código de status.

Como os endpoints de APIs fornecem uma maneira para que aplicações e sistemas internos e externos acessem e integrem dados, eles também apresentam um possível ponto de entrada para agentes mal-intencionados. Ataques de denial-of-service distribuído (DDoS) podem usar solicitações legítimas, mas em quantidades absurdas para inundar um servidor. Outros tipos de ataques podem tentar usar endpoints de APIs para extrair mais informações do que o cliente está autorizado a receber ou usar endpoints de APIs para instalar malware ou código malicioso.

Há várias maneiras pelas quais uma organização pode manter a segurança de seus endpoints de APIs e a segurança geral de APIs, incluindo:

Os recursos de APIs são conjuntos de dados ou objetos fornecidos pelas APIs. Os recursos variam de acordo com a API em questão, mas os tipos de conteúdo incluem texto, tabelas, arquivos de origem, áudio, vídeo, imagens, usuários, produtos e muito mais.

Um endpoint de API é o local específico desses recursos em um servidor. É um ponto de contato entre um cliente e um servidor de API, para onde as chamadas de API são direcionadas.

Pense em uma listagem de empresas para uma loja. A listagem fornece a localização da loja (endpoint) e como contatá-la para solicitar informações como horário de funcionamento da loja e inventário de produtos (recursos).