Documentação da API

Documentacao da API

Referencia completa dos endpoints publicos do TagLock.

Autenticacao

Todas as requisicoes exigem o header X-API-Key com sua chave de API da empresa.

Formato da chave: tl_ seguido de 32 caracteres hexadecimais.

Endpoints

POST
/v1/track

Retorna o historico de posicoes de um tag em um intervalo de tempo.

Intervalo maximo: 7 dias. endTime deve ser posterior a startTime.

Parametros

NomeTipoObrigatorioDescricao
deviceImeistring
sim
IMEI do dispositivo GPS
startTimestring
sim
Inicio do periodo (YYYY-MM-DD HH:MM:SS, UTC)
endTimestring
sim
Fim do periodo (YYYY-MM-DD HH:MM:SS, UTC)

curl

curl -X POST "https://u9m1cu191a.execute-api.us-east-2.amazonaws.com/v1/track" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: tl_SUA_CHAVE_AQUI" \
  -d '{"deviceImei":"864475000000001","startTime":"2026-04-15 00:00:00","endTime":"2026-04-15 08:00:00"}'

JavaScript

const response = await fetch("https://u9m1cu191a.execute-api.us-east-2.amazonaws.com/v1/track", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "tl_SUA_CHAVE_AQUI",
  },
  body: JSON.stringify({
    deviceImei: "864475000000001",
    startTime: "2026-04-15 00:00:00",
    endTime: "2026-04-15 08:00:00",
  }),
});
const json = await response.json();
console.log(json);

Exemplo de resposta

{"success":true,"data":[{"lat":-23.5505,"lng":-46.6333,"speed":45,"course":90,"posType":"GPS","gpsTime":"2026-04-15 08:00:00"},{"lat":-23.5510,"lng":-46.6340,"speed":30,"course":95,"posType":"GPS","gpsTime":"2026-04-15 08:05:00"}],"error":null}
POST
/v1/latest-point

Retorna a ultima posicao conhecida de um tag.

Janela de tempo (ultimas 24h) calculada no servidor. O cliente nao pode alterar o intervalo.

Parametros

NomeTipoObrigatorioDescricao
deviceImeistring
sim
IMEI do dispositivo GPS

curl

curl -X POST "https://u9m1cu191a.execute-api.us-east-2.amazonaws.com/v1/latest-point" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: tl_SUA_CHAVE_AQUI" \
  -d '{"deviceImei":"864475000000001"}'

JavaScript

const response = await fetch("https://u9m1cu191a.execute-api.us-east-2.amazonaws.com/v1/latest-point", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "tl_SUA_CHAVE_AQUI",
  },
  body: JSON.stringify({ deviceImei: "864475000000001" }),
});
const json = await response.json();
console.log(json);

Exemplo de resposta

{"success":true,"data":{"lat":-23.5505,"lng":-46.6333,"speed":0,"course":180,"posType":"GPS","gpsTime":"2026-04-15 10:00:00"},"error":null}

Erros

Todos os endpoints retornam os seguintes codigos de erro padrao:

CodigoDescricao
401
Chave de API invalida ou ausente.
403
Empresa suspensa. Contate o administrador.
429
Limite de requisicoes excedido. Aguarde antes de tentar novamente.