Autenticação

Todas as requisições enviadas à Connect devem incluir um token de autenticação, que é obtido através do envio de um nome de usuário e senha válidos.

Durante o processo de autenticação, a API retorna um token juntamente com o campo expirationDate, que indica o período de validade do token. Por padrão, o tempo de expiração é de 24 horas, porém esse valor pode ser configurado conforme a necessidade. É essencial que o cliente gerencie adequadamente o ciclo de vida do token, garantindo sua renovação antes da expiração para evitar falhas nas requisições.

A rota /Authenticate permite que os usuários obtenham um token de acesso para utilizar as outras funcionalidades do Connect. Para isso, um nome de usuário e senha devem ser submetidos. Se as credenciais estiverem corretas, a rota retorna um token válido e sua data de expiração. Em caso de erro, como credenciais inválidas ou problemas no servidor, mensagens apropriadas são retornadas.

📘

Endereço dos nossos serviços:

Homologação:

POST https://homologapix.clearsale.com.br/connect/v1/authenticate

Produção:

POST https://apix.clearsale.com.br/connect/v1/authenticate

Body Params

Exemplo Request

POST https://homologapix.clearsale.com.br/connect/v1/authenticate
Content-Type: application/json 
 
{   
   "user": "{Your user}",    
   "password": "{Your password}"
}

Status Response

Exemplo Response

HTTP/1.1 200 OK
Content-Type: application/json;  charset=utf-8 
 
{  
  "token": "{Token JWT}",  
  "expirationDate": "{Data e hora de expiração}"
}

Response com erro

"User or Password not authorized"