Autenticação

A API do Menthor utiliza chaves de API para garantir a segurança dos endpoints. Todas as requisições devem incluir uma chave válida no cabeçalho (Header) da mensagem.

Configuração do Header

Para interagir com o serviço, adicione o seguinte campo ao header da requisição HTTP:

X-API-Key: sua_chave_aqui

Exemplo com cURL

Abaixo, um exemplo de como realizar o «ping» na API utilizando a autenticação via terminal:

curl -X GET http://localhost:8000/ping \
     -H "X-API-Key: sua_chave_aqui"

Erros de Autenticação

Se a chave estiver ausente ou for inválida, a API retornará os seguintes códigos:

  • 403 Forbidden: A chave de API não foi fornecida ou não tem permissão para aceder ao recurso.

  • 401 Unauthorized: A chave fornecida expirou ou é inválida para este ambiente.

Dica

As chaves de API são configuradas no ficheiro .env do servidor. Se precisar de uma nova chave ou de acesso para um novo desenvolvedor, contacte o administrador do sistema.