Skip to main content
A Agroop API utiliza API Key como método de autenticação para garantir segurança e identificação da entidade que faz os pedidos.

​
Formato da Autenticação

Todos os pedidos à API (exceto os que servem para obter a chave) devem incluir o cabeçalho Authorization com o seguinte formato:
Atenção: É obrigatório incluir o prefixo ApiKey antes da sua chave. Se colar apenas a chave, sem este prefixo, a autenticação falhará.

​
Endpoints que requerem autenticação

Atualmente, a API tem cinco endpoints principais.
Todos os pedidos exigem a API Key exceto:
• POST /access/token → Para gerar um token temporário enviado por e-mail.
• POST /access → Para recuperar a API Key como token temporário. Os restantes endpoints necessitam do cabeçalho Authorization com o formato correto.

​
Exemplo de pedido autenticado

request
Lista dos endpoints que requerem autenticação:
• GET /devices/serials → Listar equipamentos.
• GET /devices/{profile}/{serial} → Obter informação do equipamento.
• GET /devices/{profile}/{serial}/readings → Obter leituras do equipamento.
• DELETE /access → Revogar a API Key.

​
Boas práticas de segurança

• Guarde a sua API Key em local seguro e não a partilhe publicamente.
• A API Key é única para a sua entidade e permite acesso a todos os dispositivos associados.
• Em caso de comprometimento, revogue a API Key imediatamente utilizando DELETE /access.
Atenção: Caso revogue a API Key, será necessário entrar em contacto com a equipa de suporte da Agroop para gerar uma nova API Key.

​
Dica

Caso perca a sua API Key, pode recuperá-la através da página Recuperar API Key no cabeçalho ou usando os endpoints de acesso:
• POST /access/token → Gerar token.
• POST /access → Obter API Key.