Obter Alarmes

GET

/alarms

Lista, de forma paginada, os alarmes gerados pelos equipamentos informados dentro de um período.

Disponível para: Revendedor e Cliente
Rate limit: 80 requisições/minuto (operação pesada)

📌 Esta é a versão da documentação para token de Revendedor.

⚠️ Apesar de ser GET, os filtros são enviados no corpo JSON da requisição (não na query string). O corpo é obrigatório: sem filtros, envie {} (sem corpo a API responde 400).

Revendedor x Cliente

Revendedor: considera qualquer IMEI do revendedor que esteja vinculado a um ativo.

Cliente: considera apenas IMEIs de ativos do próprio cliente; os demais são ignorados.

Regras

IMEIs inexistentes, fora do seu escopo ou sem ativo vinculado são ignorados silenciosamente (não geram erro).

startDate e endDate no formato AAAA-MM-DD hh:mm:ss.

perPage vai de 1 a 100 (padrão 20). Os resultados vêm em ordem cronológica crescente.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

🟠400Bad request

🟠403Forbidden

🟠404Registry not found

🔴500Internal server error

🟠429Too Many Request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.cloud-services.yuv.com.br/alarms' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "deviceImeis": [
        "864993060000000"
    ],
    "startDate": "2025-05-20 00:00:00",
    "endDate": "2025-05-20 23:59:59",
    "page": 1,
    "perPage": 20
}'

Response Example

200 - Sucesso

{
    "currentPage": 1,
    "data": [
        {
            "deviceImei": "864993060000000",
            "assetPrefix": "CAM-01",
            "assetIdentifier": "ABC1D23",
            "driverId": 12,
            "driverName": "João da Silva",
            "customerName": "Transportadora Exemplo",
            "alarmName": "Fadiga",
            "alarmLatitude": "-23.550520",
            "alarmLongitude": "-46.633308",
            "alarmTime": "20/05/2025 07:42:30",
            "alarmFiles": [
                "https://files.yuv.com.br/alarms/123/foto.jpg"
            ]
        }
    ],
    "lastPage": 1,
    "perPage": 20,
    "total": 1
}

Modificado em 2026-10-02 19:54:03

Obter Alarmes

Revendedor x Cliente#

Regras#

Requisição

Respostas

Revendedor x Cliente

Regras