Cloud API v1

Visão geral

A API Cloud disponibiliza os dados de processamento de dispositivos da HiTekNova via HTTPS em JSON. Cada endpoint recebe uma requisição POST com corpo JSON e retorna uma resposta JSON. Todos os endpoints de consulta exigem um JWT Bearer obtido via RegisteredToken.

URL base e autenticação

Todos os endpoints compartilham a mesma URL base. Envie seu JWT no cabeçalho Authorization.

Authorization header

Authorization: Bearer <JWT>
Content-Type: application/json

Autenticação — RegisteredToken

Troque seu nome de usuário e senha do painel por um JWT. O token contém seu customer_id, de modo que toda chamada subsequente fica automaticamente restrita à sua conta. Os tokens são de longa duração — armazene-os em cache.

Parâmetros obrigatórios

Exemplo — Requisição

curl -X POST https://cloudapi.hiteknova.com/ClientDataAPI/RegisteredToken \
  -H "Content-Type: application/json" \
  -d '{"username":"yourlogin","password":"yourpassword"}'

Resposta

Em caso de sucesso, o JWT é retornado como string bruta no corpo (sem envelope JSON). Use-o como Authorization: Bearer <token> nas demais chamadas.

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6...

Busca individual — getByImei

Consulte o histórico de um único IMEI ou número de série. Corresponde a imei_esn ou serial_number. Retorna até 100 registros por chamada, paginados via fromid.

Parâmetros obrigatórios

Parâmetros opcionais

Exemplo

curl -X POST https://cloudapi.hiteknova.com/ClientDataAPI/getByImei \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{"imei":"356360390499091"}'

Resposta

{
  "status": 1,
  "msg": "",
  "total": 2,
  "has_more": false,
  "last_id": 60185,
  "data": [ { /* device record */ }, ... ]
}

Todos os endpoints de consulta (getByImei, getByImeiBulk, getAllDevices, getByUser, getByMachine) retornam registros com a mesma estrutura. Veja Campos do registro de dispositivo para a referência completa.

Busca em lote — getByImeiBulk NEW

Consulte o histórico de até 100 IMEIs ou números de série em uma única chamada. A flag latest (padrão true) retorna um registro (o mais recente) por entrada correspondente, na ordem da solicitação — o caminho mais rápido para verificar "tenho esses dispositivos?". Use latest: false para histórico completo com paginação por id ASC via from_id / last_id.

Parâmetros obrigatórios

Parâmetros opcionais

Exemplo — latest (default)

curl -X POST https://cloudapi.hiteknova.com/ClientDataAPI/getByImeiBulk \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{
    "imeis": ["356360390499091","356360393577562","358991131387944"]
  }'

Exemplo — full history, paged

{
  "imeis": ["356360390499091"],
  "latest": false,
  "fromdate": "2026-01-01",
  "limit": 100
}

// next page
{
  "imeis": ["356360390499091"],
  "latest": false,
  "from_id": 60190,
  "limit": 100
}

Exemplo — filters

{
  "imeis": ["356360390499091","356360393577562"],
  "latest": false,
  "erase_result": "passed",
  "os_type": "Android",
  "model_name": "Galaxy S24",
  "fromdate": "2026-01-01",
  "todate": "2026-04-15"
}

Resposta

{
  "status": 1,
  "msg": "",
  "total": 3,
  "has_more": false,
  "last_id": 60185,
  "data": [
    {
      "id": 60184,
      "IMEI": "356360393577562",
      "IMEI2": "357332263577567",
      "SerialNumber": "R5CXB08H4PJ",
      "ModelName": "Galaxy S24 FE",
      "Capacity": "256GB",
      "RAM": "8GB",
      "BatteryMaxCapacity": "98%",
      "ErasureStatus": "Passed",
      // ... see Device Record Fields below
    }
  ]
}

Listar dispositivos — getAllDevices

Lista os registros de dispositivos do cliente autenticado, filtrados por data e tipo de relatório. Retorna até 100 registros, paginados por fromid.

Parâmetros opcionais

Exemplo

curl -X POST https://cloudapi.hiteknova.com/ClientDataAPI/getAllDevices \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{"fromdate":"2026-03-01","todate":"2026-04-15","report_type":"erase"}'

Resposta

{
  "status": 1,
  "msg": "",
  "total": 100,
  "has_more": true,
  "last_id": 60110,
  "data": [ { /* device record */ }, ... ]
}

Todos os endpoints de consulta (getByImei, getByImeiBulk, getAllDevices, getByUser, getByMachine) retornam registros com a mesma estrutura. Veja Campos do registro de dispositivo para a referência completa.

Consultar por usuário — getByUser

Lista os registros criados por um operador específico (username). Use para relatórios por técnico.

Parâmetros obrigatórios

Parâmetros opcionais

Exemplo

curl -X POST https://cloudapi.hiteknova.com/ClientDataAPI/getByUser \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{
    "username":"operator01",
    "fromdate":"2026-03-01",
    "todate":"2026-04-15",
    "fromid":0,
    "report_type":"all",
    "data_format":1
  }'

Consultar por máquina — getByMachine

Lista os registros processados em uma máquina TestPod específica (machine_sn).

Parâmetros obrigatórios

Parâmetros opcionais

Exemplo

curl -X POST https://cloudapi.hiteknova.com/ClientDataAPI/getByMachine \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{
    "machine_sn":"TP-001234",
    "fromdate":"2026-03-01",
    "todate":"2026-04-15",
    "fromid":0,
    "report_type":"all"
  }'

Mapeamento de SKU — getSku

Busca a tabela de mapeamento de SKU da sua conta. Retorna linhas sku, sku_1, sku_2 usadas para enriquecer as respostas de getBy*.

Exemplo

curl -X POST https://cloudapi.hiteknova.com/ClientDataAPI/getSku \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{}'

Resposta

{
  "status": 1,
  "data": [
    { "sku": "SKU001", "sku_1": "Alias A", "sku_2": "Alias B" }
  ]
}

Campos do registro de dispositivo

Cada registro retornado pelos endpoints de consulta possui a seguinte estrutura. Campos podem vir vazios quando o valor não está disponível.

Tratamento de erros

Em caso de falha, os endpoints retornam status: 0 e um msg legível. Em caso de sucesso, status: 1.

{
  "status": 0,
  "msg": "Data format incorrect"
}

Suporte

Precisa de uma conta, um novo token ou ajuda com a integração? Entre em contato.

E-mail: support@hiteknova.com