O que é Endpoint?

O ponto de acesso de um serviço

Endpoint é um ponto de acesso a um recurso ou função de um serviço. Em uma API HTTP, ele é identificado por um endereço, e o método participa da definição da operação. A documentação pode usar a palavra para o endereço ou para a combinação de método e caminho.

Quando você configura uma integração para consultar contatos, precisa saber qual endereço recebe essa consulta. Conhecer apenas o domínio não define como chamar o serviço. O caminho, o método e as exigências do contrato completam a requisição.

Considere uma API fictícia com base em https://api.example.com/v1. O caminho /contatos/42 pode identificar o contato 42 nessa versão. A URL completa permite localizar o recurso, enquanto GET expressa a intenção de consultá-lo.

Endereço base, caminho e parâmetros

O endereço base costuma reunir esquema, host e um prefixo comum, como a versão da API. O caminho acrescenta a localização específica do recurso. Parâmetros podem selecionar um registro ou ajustar uma consulta, conforme a estrutura documentada.

Em /contatos/42, o identificador faz parte do caminho. Em /contatos?pagina=2, a página está na consulta da URL. Trocar essas posições não preserva automaticamente o significado, porque a aplicação precisa reconhecer a forma recebida.

Base: https://api.example.com/v1
GET /contatos       → listar contatos
GET /contatos/42    → consultar um contato
POST /contatos      → criar um contato

Essas convenções são exemplos, sem uma forma única de nomear recursos. Uma API pode usar outros caminhos ou atender recursos diferentes no mesmo endereço. Você precisa seguir o contrato do serviço real.

O endpoint não descreve todo o contrato

Além do endereço e do método, uma chamada pode exigir autenticação, campos obrigatórios e cabeçalhos específicos. A documentação também precisa explicar as respostas possíveis. Um endereço correto com conteúdo incompatível ainda pode resultar em recusa.

Um endpoint acessível não significa que qualquer perfil autenticado possa usá-lo. O servidor ainda precisa verificar a identidade e a permissão para o recurso solicitado. O identificador de um registro não deve funcionar como autorização.

Como investigar uma chamada recusada

Confira primeiro o endereço completo, incluindo host, prefixo de versão e caminho. Depois, compare o método e os parâmetros com a documentação. Evite testar operações de alteração apenas para descobrir qual verbo é aceito.

404 pode indicar rota ou recurso ausente, além de uma política que não revela sua existência. 405 indica que o método não é permitido naquele recurso e deve vir com os métodos aceitos em Allow. Esses códigos são pontos de partida para conferir o contrato.

O verbete de método HTTP explica como a finalidade da chamada se combina com o endereço acessado.

Aplicação na formação

Vibe Coding: Do Zero ao MVP

O endpoint identifica o ponto de acesso usado para consultar ou alterar um recurso oferecido pela API.

Conhecer a formação →