Este endpoint permite gerar um token temporário para acesso ao Painel do Cliente, sem que o cliente precise realizar a autenticação manualmente.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
POST | https://api.tomticket.com/v2.0/customer/access/new | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Para utilizá-lo, é necessário possuir um Token de Acesso válido.
O token deve ser enviado no cabeçalho HTTP:
Authorization: Bearer SEU_TOKEN_AQUIParâmetros da requisição
Os parâmetros devem ser enviados no corpo da requisição utilizando form-data.
Parâmetros da requisição - Gerar acesso ao Painel do Cliente
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
customer_id | string | Sim | 250 | Identificador interno do cliente ou endereço de e-mail utilizado no cadastro. |
customer_type_id | string | Não | 1 | Tipo de identificador informado em customer_id. Opções: I - Identificador interno; E - Endereço de e-mail. Valor padrão: I. |
JSON de saída
Em caso de sucesso, a API retorna um token temporário e a URL que deverá ser utilizada para redirecionar o cliente ao Painel do Cliente.
JSON de saída - Gerar acesso ao Painel do Cliente
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | Informa se ocorreu erro na operação. |
message | string | Mensagem de retorno da operação. |
access_token | string | Token temporário utilizado para acessar o Painel do Cliente. |
url | string | URL para a qual o cliente deverá ser redirecionado. |
success | boolean | Retorna true quando a operação é concluída com sucesso. |
Códigos HTTP
| Código | Descrição |
|---|---|
200 | Token temporário gerado com sucesso. |
401 | Token de autenticação inválido ou parâmetros enviados inválidos. |
403 | A operação não está disponível para a conta ou para o token informado. |
404 | Cliente não encontrado. |