Autenticação

POST /api/v1/authenticateCopied!

Este endpoint valida o token de integração informado no cabeçalho e retorna um novo JSON Web Token (JWT), que deverá ser usado como Bearer token nas chamadas aos demais endpoints protegidos da API.

No header da requisição você irá passar o token fornecido pelo nosso suporte.

"Authorization": "Bearer 2|K5xuNq9qBaZLIEFVCT1xPiEPxe312312dsa487"

Não compartilhe seu access token!

Você receberá uma resposta contendo o bearer token e o tempo de duração dele em segundos.

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJpc3MiOiJodHRwOi8vYXBpLmxvY2FsaG9zdDo4MDAwL2FwaS92MS9hdXRoZW50aWNhdGUiLCJpYXQiOjE3NDg1NDEwNjgsImV4cCI6MTc0ODU0NDY2OCwibmJmIjoxNzQ4NTQxMDY4LCJqdGkiOiJPbmhmN2dyZ2tUb3JVQ0xIIiwic3ViIjoiMSIsInBydiI6IjYyNmM3MjQ5MjkzYzQ5NjE0MTZlMjRjNzdhMjU5YzUyNjM2N2IzMmYifQ.jFnV8lHwYcedfWvL5D852nxG9AZ4Y1-KQSM1-Z_vbl9Oq3_xSisgY4OJyLFky8U5v8oapLVSbRUPc3gAmKSnMn70x8GcOGFzYjtYd8T4UViukQA0eUsU-zcaQxF7gbWxIawquz8Og6y23i3a70ifHno4YpsFHQCtfS4DnZSzhjqBIulgMsvZ2oz8dFsHfDoR7obxJ1MIIsQ9a_6TkN_HpThGlgILYSYiW6g7AR0BSFoOSDvler74JTnow3tSJPNF8vgGhpAjtPA-1xKKt0FMsrAlT73zVayeEaSe_tZOIuWzgFue3kMnZoUj8-2jG1iW_8LPzOX5r_Jb8NuGTzHGl_kI0JpWAzZ1IfJKGeaYAXACxIj7X_fV0XJSYePGmIcfD7kS9j6mxY4DLMkgq8DqJ9Mesy1mTPgOjX9J679SAN_sbwtRp5fELAq3cRJZ03LVLwqqWQ7FPP7KXE1OXNjIxrA08RnaModCcloa2o4A7J2IDMPIab_Yz5wYirhO-ZyaUmBjJMrCps4nyEPiugT_gnfPbxeQ8IcoozCzaC2kAIPAQSLj7YuZkB5k15xNQYIkD0Fave-Jl6UQj2asZyiZSZK3GCz29kP3VU8ogPxC1aGi2h-rOlowYkq_R-bd-N7h6cgi0XbuCXAAyjEpC1k5PQ7bPdajqzXMfk6XI8RH9RY",
    "token_type": "Bearer",
    "expires_in": 3600
}

O token retornado deve ser adicionado ao header “Authorization“ das requisições futuras aos endpoints protegidos, no formato "Bearer <token>":

"Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDAvYXBpL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcxNTE5ODk3NCwiZXhwIjoxNzE1MjIwNTc0LCJuYmYiOjE3MTUxOTg5NzQsImp0aSI6IjkzUXp4cWRINDYxQ2d0cmIiLCJzdWIiOiIzOCIsInBydiI6ImU5NzllMzk2ZGU1YzFjZjE2YjVkZjQ1ODhiYWQyZjVlODhiNjUwODUifQ.jeYJiMwPYrv8YfVDilDFuyGPP1YWA97yw03yv31Tp9M"

POST /api/v1/refresh-tokenCopied!

Este endpoint renova o JSON Web Token (JWT) em uso, estendendo seu tempo de validade. Deve ser chamado antes da expiração do token atual.

O token que vem sendo utilizado deve ser passado ao header “Authorization“ para poder renova-lo:

"Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDAvYXBpL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcxNTE5ODk3NCwiZXhwIjoxNzE1MjIwNTc0LCJuYmYiOjE3MTUxOTg5NzQsImp0aSI6IjkzUXp4cWRINDYxQ2d0cmIiLCJzdWIiOiIzOCIsInBydiI6ImU5NzllMzk2ZGU1YzFjZjE2YjVkZjQ1ODhiYWQyZjVlODhiNjUwODUifQ.jeYJiMwPYrv8YfVDilDFuyGPP1YWA97yw03yv31Tp9M"

E retorna o token e a expiração:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJpc3MiOiJodHRwOi8vYXBpLmxvY2FsaG9zdDo4MDAwL2FwaS92MS9yZWZyZXNoLXRva2VuIiwiaWF0IjoxNzQ4NTQxMTEwLCJleHAiOjE3NDg1NDQ3MTAsIm5iZiI6MTc0ODU0MTExMCwianRpIjoicnF0Y3NLUklmTWVpNXZ6SyIsInN1YiI6IjEifQ.WS3BWDmZ0ovXdwEQrGPfETVzTAawcv2ozMKbJLtNXO6bEZi3DcrWsO09C2CNX6dOmibEloO4GKF1OTHtl9Nrhl8WLvRL0pV-D5cowRv4zKAMiWR8FiviRDsRDx6lI4RJF0V5XR2aI3sS60sXRkQJUqQ_PgZynkE_quXT7Y7ChMq5kgEjer2vYNiJyspHMtq0r_FuU9TefDLBTs48y9uzt9OQ12l2LpTN_goXng83iWs35QaFAlltHo-tO_NAoJyGp6NvmHHivOrX-9YPpmNU7wGvp46bWw4Vp_e9nB4AftzP1MbjxkK1va2nMOAEETsDVoynHQVGFDTeSp0nCuJ6zafA8BA4U6XsAC9_6-226T4pJ8mMlia0sm9TAMMFIjnmWzT1cBGiUsI5xiisV5X4z4IdZgfFW3aDMDDu4fSADxJDkqCRFnpk76dVntTtBR_AuiisDxwryVX4_RP1Q_U7wfSq_t6OoL9BDtBUhcJ1VkFYeEbzvkjhbBjbab0dcPSYZUcZGbAh04Y_HJm1_nLwEueW0iOGQF5ixES5_kXj991kM5tHW4PneM6b-OBkVG5OwbBOeMYKvwKu1rLXS9DlEcT0f3K6IH2VoEgZt2qqp5Ip62fCT38QqInZ5zEQ34tMSl40xlkR3s19Ssv5Vx7DzFVgfuUueXPfIUgqUnBuelA",
    "token_type": "bearer",
    "expires_in": 3600
}

Após o tempo de expiração do token, uma nova autenticação é necessária para obter um novo token.

Quando o servidor receber a requisição com o bearer token no header, ele irá validar esse token para garantir que seja válido. Se for, a requisição será processada normalmente e a resposta apropriada será retornada. Se o token for inválido ou expirado, o servidor retornará uma resposta de erro indicando que a requisição não foi autorizada:

401 | UNAUTHORIZED