Geração de API Key de Acesso
Para acessar a API, cada cliente precisa de credenciais de autenticação que devem ser incluídas em todas as requisições HTTP.
Como obter as credenciais
Para obter acesso à API, o cliente deve entrar em contato com o time de suporte. O suporte criará um usuário e fornecerá as seguintes credenciais:
- Role ID (
roleid) - Identificador da role/permissão do usuário - API Key (
x-api-key) - Chave de autenticação única
Uso das credenciais
Ambas as credenciais devem ser enviadas como headers em todas as requisições:
POST /samples_statistics
Content-Type: application/json
roleid: 1dcedd1737b59b57d54892985ce6e78c
x-api-key: sua-api-key-aqui
{
"lat": -23.5505,
"lon": -46.6333,
"distance": 1000
}
Role ID
O roleid é um identificador único associado a uma role específica dentro do sistema. Ele é utilizado para autenticar e autorizar o acesso aos recursos da API. Cada cliente deve fornecer o roleid correto no cabeçalho de suas solicitações para garantir que as permissões adequadas sejam aplicadas.
API Key
A x-api-key é uma chave de autenticação única fornecida pelo suporte para cada cliente. Esta chave deve ser mantida em segurança e nunca compartilhada publicamente.
Erros de autenticação
Se as credenciais não forem fornecidas ou forem inválidas, a API retornará um erro de autenticação com status code apropriado.