Pular para o conteúdo principal

Autenticação

A plataforma usa autenticação JWT (JSON Web Token). Você se autentica com suas credenciais e recebe um token que deve ser incluído em todas as requisições subsequentes.

Suas credenciais (usuário e senha) são fornecidas pelo time da plataforma durante o onboarding. Entre em contato com seu gerente de conta se ainda não as recebeu.

Obtendo um Token​

POST/v1/auth
Request
{
"username": "your-user@yby-dev.positivolabs.com.br",
"password": "your-password"
}

Parâmetros do Corpo​

CampoTipoObrigatórioDescrição
usernamestring✓Usuário fornecido pelo time
passwordstring✓Senha fornecida pelo time
Response
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"expires_in": 300,
"refresh_expires_in": 1800,
"refresh_token": "eyJhbGciOiJIUzI1NiIs...",
"token_type": "Bearer"
}

Campos da Resposta​

CampoTipoDescrição
access_tokenstringJWT enviado no header Authorization de cada requisição
expires_inintegerValidade do access_token, em segundos
refresh_tokenstringToken usado para obter um novo access_token sem reautenticar
refresh_expires_inintegerValidade do refresh_token, em segundos
token_typestringTipo do token — sempre Bearer

Expiração do Token​

TokenExpiraçãoUso
access_token5 min (300s)Enviado no header Authorization em cada chamada
refresh_token30 min (1800s)Obtém um novo access_token sem reautenticar

Fazendo Requisições Autenticadas​

Inclua o access_token no header Authorization de cada requisição:

Authorization: Bearer <access_token>

Melhores Práticas​

  • Nunca compartilhe suas credenciais ou tokens publicamente
  • Armazene credenciais de forma segura usando variáveis de ambiente
  • Implemente renovação automática de token antes da expiração
  • Não codifique tokens diretamente no código — eles expiram e são rotacionados