Pular para o conteúdo principal

Autenticação

A autenticação das ferramentas Codilo é realizada por meio de um microserviço centralizado responsável por validar e emitir tokens de acesso para todas as nossas ferramentas.

URL base de autenticação: https://auth.codilo.com.br

Para utilização das ferramentas, adotamos o padrão OAuth 2.0 utilizando o fluxo Client Credentials, apropriado para integrações entre sistemas (server-to-server). Nesse modelo, a aplicação cliente utiliza sua id e secret para solicitar um access_token temporário. O token retornado é do tipo JWT, possui tempo de expiração e deve ser enviado obrigatoriamente no header Authorization em todas as requisições aos endpoints protegidos.

A obtenção do token deve ser realizada por meio da seguinte requisição:

POST https://auth.codilo.com.br/oauth/token

Body da requisição (JSON):

{
"grant_type": "client_credentials",
"id": "SUA_KEY",
"secret": "SEU_SECRET"
}

Resposta (JSON):

{
"token_type": "Bearer",
"access_token": "SEU_ACCESS_TOKEN",
"expires_in": 3600
}

O campo access_token contém o token JWT que deverá ser utilizado nas chamadas às ferramentas Codilo. O tempo de validade do token é definido pela propriedade expires_in, informada em segundos.

O token deve ser enviado no header Authorization no seguinte formato:

Authorization: Bearer SEU_ACCESS_TOKEN

Caso o token esteja expirado, inválido ou não seja informado, a ferramenta retornará o status 401 - Unauthorized. Nessa situação, será necessário realizar uma nova requisição ao endpoint /oauth/token para gerar um novo access_token.

Status possíveis de retorno:

StatusSignificadoDescrição
200OKRequisição realizada com sucesso
401UnauthorizedToken inválido, expirado ou não informado
429Too Many RequestsLimite de requisições excedido