Autenticação

POST /authenticate

Para acessar os endpoints protegidos da API, você precisa de um bearer token. Ele é gerado pelo endpoint de autenticação, usando o seu access token.

Proteja seu access token

Não compartilhe, não publique em repositórios e não exponha em aplicações front-end.

Como autenticar

1. Envie seu access token

No corpo da requisição, envie o access token:

{
    "access_token": "e87cd05c35ddc024772f84abcbaaaf10ce5641b31a4492895935c707e0e2ec0f008dfbf4e251ca0c3ff23ae448df3e86103807a55873823f6d1b11dae5861cc"
}

2. Receba o bearer token

A resposta traz o bearer token e o tempo de validade dele, em segundos:

{
    "authorization": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDAvYXBpL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcxNTE5ODk3NCwiZXhwIjoxNzE1MjIwNTc0LCJuYmYiOjE3MTUxOTg5NzQsImp0aSI6IjkzUXp4cWRINDYxQ2d0cmIiLCJzdWIiOiIzOCIsInBydiI6ImU5NzllMzk2ZGU1YzFjZjE2YjVkZjQ1ODhiYWQyZjVlODhiNjUwODUifQ.jeYJiMwPYrv8YfVDilDFuyGPP1YWA97yw03yv31Tp9M",
        "type": "bearer",
        "expires_in": 21600
    }
}
CampoTipoDescrição
tokenstringBearer token que você usará nas próximas requisições.
typestringTipo do token (bearer).
expires_inintegerTempo de validade em segundos (21600 = 6 horas).

3. Use o token nas requisições

Envie o token no cabeçalho Authorization de todas as chamadas aos endpoints protegidos, no formato Bearer :

{
    "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

Expiração do token

Quando o token expira, basta repetir a autenticação para obter um novo.

😼

Dica

Guarde o token e reutilize-o até perto do vencimento, em vez de autenticar a cada requisição. Assim você evita chamadas desnecessárias.

Token inválido ou expirado

A cada requisição, o servidor valida o bearer token. Se ele for válido, a requisição é processada normalmente. Se for inválido ou estiver expirado, a API retorna o erro abaixo:

401 Unauthorized

⚠️

Recebeu um 401?

Verifique se o token não expirou e se o cabeçalho está no formato Authorization: Bearer


Did this page help you?