Skip to main content

API Autenticação

URL de Chamada

GET: https://api-auth-hmg.ducash.com.br/auth/token?clientId={ClientID}&clientSecret={ClientSecret}

GET: https://api-auth-prd.ducash.com.br/auth/token?clientId={ClientID}&clientSecret={ClientSecret}

Serviço responsável por fornecer o token para acesso às APIs em homologação e produção, respectivamente. O access token gerado é válido por 1h e o refresh token é válido por 30 dias. Caso seja necessário um novo access token ou refresh token após o período válido, pode-se utilizar a rota de refresh descrita posteriormente nesse documento.

Obs: Os valores de ClientID e ClientSecret serão fornecidos pela equipe da Du Benefícios em conjunto com o token gerado.

Parâmetros enviados

CampoTipoDescrição
clientIDstringClientID gerado para o cliente.
clientSecretstringClientSecret gerado para o cliente.
Obs: Os campos acimas são obrigatórios

Parâmetros recebidos

CampoTipoDescrição
access_tokenstringToken de acesso à ser fornecido no cabeçalho de autorização das chamadas às APIs.
refresh_tokenstringRefresh token utilizado para obter um novo token através da rota refresh.

Respostas

Exemplo de resposta: Token gerado (Status HTTP: 200 OK)

{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjRnUkVsd1lGVTdkQWZ6MFU0bHc4Wld2SlMyUGNEbjRIc0I5M2s0UkR6elkzcHZLajloRlVaVHM4UzBCWXUwYyIsImNsaWVudFNlY3JldCI6IkdKSXZRZzVXWnNpaGNKSU9qaUFMZkpvM1JaaERtYlZ1Z2x1VnRabGEzeUZ1UVh3WjFteFh2THpDa1Y0Z1V1bSIsImlhdCI6MTcyMzA1MDE5NywiZXhwIjoxNzIzMDUzNzk3fQ.ZqDMVJo795zUn_bCH-DPPbM0eKJNmXgtX_hRsD2tZGI",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjRnUkVsd1lGVTdkQWZ6MFU0bHc4Wld2SlMyUGNEbjRIc0I5M2s0UkR6elkzcHZLajloRlVaVHM4UzBCWXUwYyIsImNsaWVudFNlY3JldCI6IkdKSXZRZzVXWnNpaGNKSU9qaUFMZkpvM1JaaERtYlZ1Z2x1VnRabGEzeUZ1UVh3WjFteFh2THpDa1Y0Z1V1bSIsImlhdCI6MTcyMzA1MDE5NywiZXhwIjoxNzI1NjQyMTk3fQ.ETfX6JTAE7ELflAi_ZDBxQyh72IcfIaUhLuxpKcp46A"
}
Obs: Dados fictícios

URL de Chamada

GET: https://api-auth-hmg.ducash.com.br/auth/refresh?token={RefreshToken}

GET: https://api-auth-prd.ducash.com.br/auth/refresh?token={RefreshToken}

Serviço responsável por fornecer um novo token para acesso às APIs a partir do refresh token obtido pela rota de token em homologação e produção, respectivamente. O novo token gerado é válido por 1h e o novo refresh token é válido por 30 dias.

Parâmetros enviados

CampoTipoDescrição
tokenstringRefresh Token obtido pela rota de token.
Obs: Os campos acimas são obrigatórios

Parâmetros recebidos

CampoTipoDescrição
access_tokenstringToken de acesso à ser fornecido no cabeçalho de autorização das chamadas às APIs.
refresh_tokenstringRefresh token utilizado para obter um novo token através da rota refresh.

Respostas

Exemplo de resposta: Token gerado (Status HTTP: 200 OK)

{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjRnUkVsd1lGVTdkQWZ6MFU0bHc4Wld2SlMyUGNEbjRIc0I5M2s0UkR6elkzcHZLajloRlVaVHM4UzBCWXUwYyIsImNsaWVudFNlY3JldCI6IkdKSXZRZzVXWnNpaGNKSU9qaUFMZkpvM1JaaERtYlZ1Z2x1VnRabGEzeUZ1UVh3WjFteFh2THpDa1Y0Z1V1bSIsImlhdCI6MTcyMzA1MDE5NywiZXhwIjoxNzIzMDUzNzk3fQ.ZqDMVJo795zUn_bCH-DPPbM0eKJNmXgtX_hRsD2tZGI",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6IjRnUkVsd1lGVTdkQWZ6MFU0bHc4Wld2SlMyUGNEbjRIc0I5M2s0UkR6elkzcHZLajloRlVaVHM4UzBCWXUwYyIsImNsaWVudFNlY3JldCI6IkdKSXZRZzVXWnNpaGNKSU9qaUFMZkpvM1JaaERtYlZ1Z2x1VnRabGEzeUZ1UVh3WjFteFh2THpDa1Y0Z1V1bSIsImlhdCI6MTcyMzA1MDE5NywiZXhwIjoxNzI1NjQyMTk3fQ.ETfX6JTAE7ELflAi_ZDBxQyh72IcfIaUhLuxpKcp46A"
}
Obs: Dados fictícios