...

Tokens de acesso

Leitura estimada: 2 minutos

Introdução

CIQ DEX (Digital Experience Intelligence) fornece um conjunto de APIs que permite o acesso programático a dados de desempenho e experiência coletados de dispositivos monitorados, possibilitando a integração dessas informações em sistemas externos.
Para garantir o acesso seguro e controlado a esses dados, CIQ DEX usa tokens de autenticação. Esses tokens funcionam como credenciais seguras que substituem o uso de nomes de usuário e senhas em chamadas de API, permitindo que o sistema identifique quem está fazendo as solicitações.

Este documento descreve como criar tokens de acesso e demonstra as principais maneiras de usá-los com as APIs CIQ DEX.

imagem 120 Tokens de acesso

Como criar um token

Os tokens de acesso são criados no portal administrativo CIQ DEX.
Siga as etapas abaixo:

  • Acesso "CIQ DEX> Configurações administrativas> Tokens de acesso
  • Clique em "Create Token" (Criar token)
  • Digite o nome, a descrição e a data de expiração do token.
  • Crie!
imagem 121 Tokens de acesso
CIQ DEX> Configurações administrativas> Tokens de acesso> Criar token
  • Após criar o token, copie-o imediatamente - ele não será exibido novamente. Se você o perder, precisará gerar um novo token.
imagem 122 Tokens de acesso
  • Use esse token para fazer solicitações às APIs CIQ DEX.

Para que o token pode ser usado

O token de acesso é essencial para interagir com as APIs REST CIQ DEX, permitindo a coleta automatizada de dados e a integração com outras plataformas.
Abaixo estão alguns exemplos práticos de como os tokens podem ser usados.

Recuperar informações do dispositivo

O /v1/api/ciq/machineInfo permite recuperar as informações do dispositivo associadas a um funcionário específico.
Exemplo:

GET /v1/api/ciq/machineInfo?search=email@company.com
Authorization: Bearer <your_token>

Resposta esperada:

{
  "status": true,
  "data": {
    "deviceCount": 1,
    "devices": [
      {
        "machineId": "M123456",
        "machineName": "LAPTOP-XYZ"
      }
    ]
  }
}

Esse ponto de extremidade é útil para identificar dispositivos monitorados e coletar seus identificadores correspondentes (machineId).

Recuperar métricas de desempenho e experiência digital

O /v1/api/ciq/metrics retorna métricas detalhadas sobre o desempenho e a experiência digital de um dispositivo específico.

Exemplo de solicitação:

GET /v1/api/ciq/metrics?machineId=M123456&startDate=2025-10-01&endDate=2025-10-06
Authorization: Bearer <your_token>

Resposta de amostra (simplificada):

{
  "machineInfo": {
    "name": "LAPTOP-XYZ",
    "osName": "Windows 11",
    "manufacturer": "Dell",
    "model": "Latitude 5420"
  },
  "scores": {
    "cpu": { "score": 87 },
    "memory_usage": { "score": 92 },
    "overall": { "score": 89 }
  }
}

Esses dados podem ser usados para:

  • Monitore o desempenho e a integridade do dispositivo;
  • Alimentar painéis de controle corporativos i

Documentação da API Swagger

Swagger LAD1
Swagger LAD2

Compartilhe este documento

Tokens de acesso

Ou copie o link

Índice
Role até o topo