Auth

Login

post

Processa a solicitação de login e retorna o resultado.

Corpo

application/json

emailstringObrigatório

E-mail do usuário.

passwordstringObrigatório

Senha do usuário.

device_tokenstringOpcional

accept_token_servicebooleanOpcional

is_contact_centerbooleanOpcional

Respostas

200

Login realizado.

application/json

tokenstringOpcional

401

Não autorizado.

application/json

403

Proibido.

application/json

500

Erro interno.

application/json

post

/v4/auth/login

HTTPcURLJavaScriptPython

POST /api/v4/auth/login HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "email": "[email protected]",
  "password": "senha123",
  "device_token": "device_token_abc",
  "accept_token_service": true,
  "is_contact_center": false
}

{
  "token": "jwt.token",
  "user": {
    "_id": "user_123",
    "email": "[email protected]"
  }
}

Login v2

post

Processa a solicitação de login v2 e retorna o resultado.

Corpo

application/json

emailstringObrigatório

E-mail do usuário.

passwordstringObrigatório

Senha do usuário.

device_tokenstringOpcional

accept_token_servicebooleanOpcional

is_contact_centerbooleanOpcional

Respostas

200

Login realizado.

application/json

tokenstringOpcional

401

Não autorizado.

application/json

403

Proibido.

application/json

500

Erro interno.

application/json

post

/v4/auth/login-v2

HTTPcURLJavaScriptPython

POST /api/v4/auth/login-v2 HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "email": "[email protected]",
  "password": "senha123",
  "is_contact_center": false
}

{
  "token": "jwt.token",
  "user": {
    "_id": "user_123",
    "email": "[email protected]"
  }
}

Logout

get

Processa a solicitação de logout e retorna o resultado.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

typestring · enumOpcional

Tipo de autenticação.

Example: apiValores possíveis:

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

400

Requisição inválida.

application/json

401

Não autorizado.

application/json

500

Erro interno.

application/json

get

/v4/auth/logout

HTTPcURLJavaScriptPython

GET /api/v4/auth/logout HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": true,
  "message": "Sucesso"
}

Atualizar token

get

Atualiza token conforme os dados enviados.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Token renovado.

application/json

tokenstringOpcional

401

Não autorizado.

application/json

500

Erro interno.

application/json

get

/v4/auth/refresh

HTTPcURLJavaScriptPython

GET /api/v4/auth/refresh HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "jwt.token.renovado"
}

Obter usuário autenticado

get

Recupera usuário autenticado.

Autorizações

JwtAuth

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Dados do usuário atual.

application/json

_idstringOpcional

emailstringOpcional

namestringOpcional

session_agentobject · anulávelOpcional

keep_aliveintegerOpcional

401

Não autorizado.

application/json

get

/v4/auth/me

HTTPcURLJavaScriptPython

GET /api/v4/auth/me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "user_123",
  "email": "[email protected]",
  "name": "Agente 01",
  "session_agent": {
    "_id": "session_agent_1"
  },
  "keep_alive": 30
}

Listar IDPs remotos

get

Retorna iDPs remotos conforme filtros enviados.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/remote-auth-idps

HTTPcURLJavaScriptPython

GET /api/v4/remote-auth-idps HTTP/1.1
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Desbloquear por confiança

post

Libera por confiança após validação dos dados enviados.

Corpo

application/json

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/unlock_for_trust

HTTPcURLJavaScriptPython

POST /api/v4/unlock_for_trust HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "email": "[email protected]"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}