Beyond machines — we back you up in daily life too. Looking for products like FLY?Explore now

Desenvolvedores · Eventos API

REST · JSON acima de HTTP

Eventos API.

Leia viagens pontuadas, GPS rotas e detalhamentos de nível de fator AURA acima de HTTP. A telemetria é capturada na borda pelos conectores SDK e certificados; o API dá ao seu stack o resultado pontuado e explicável. AURA apoia a subscrição — a seguradora licenciada detém autoridade sobre preços.

Início rápido

Autentique e leia uma pontuação.

Cada solicitação carrega um token ao portador e um escopo de frota opcional. As respostas são JSON com um sinalizador ok de nível superior.

Autenticação

Passe um token de portador no cabeçalho de autorização. Defina o escopo de uma solicitação para uma frota com o cabeçalho opcional x-fleet-id; omita-o e os tokens de administrador verão todas as frotas que possuem.

cURL · authenticated request
curl https://api.yas.dev/v1/trips \
  -H "Authorization: Bearer $YAS_TOKEN" \
  -H "x-fleet-id: fleet_joie"

# Base URL
# Sandbox  https://api.sandbox.yas.dev/v1
# Productionhttps://api.yas.dev/v1
200 OK · application/json
{
  "ok": true,
  "trips": [
    { "tripId": "trip_2026_0142", "overallScore": 72.4, "tier": "Good" }
  ],
  "pagination": { "page": 1, "limit": 20, "totalPages": 9, "total": 172 }
}

Referência

Pontos de extremidade principais.

Endpoints somente leitura para viagens, rotas, pontuações e veículos. A ingestão ocorre por meio de SDK e conectores, não de um endpoint de gravação público.

  • GET/v1/trips

    List scored trips, newest first, with pagination and fleet scope.

  • GET/v1/trips/{id}

    Retrieve a single trip with its summary metrics and GPS link.

  • GET/v1/trips/{id}/score-breakdown

    Theme-by-factor AURA score breakdown for one trip.

  • GET/v1/vehicles/{plate}

    Vehicle risk profile and driver roster.

Exemplo

Recuperar um detalhamento da pontuação da viagem.

A divisão agrupa cerca de 100 fatores de risco em seis temas, cada um com sua própria subpontuação, e nomeia o tema mais fraco para que você saiba onde treinar.

GET /v1/trips/{id}/score-breakdown
{
  "ok": true,
  "breakdown": {
    "tripId": "trip_2026_0142",
    "overallScore": 72.4,
    "mapMatched": true,
    "themes": [
      {
        "id": "speeding", "label": "Speeding",
        "themeScore": 68.2,
        "factors": [
          { "key": "speedingIntensity", "score": 71.5 }
        ]
      }
    ],
    "weakestTheme": { "id": "speeding", "label": "Speeding" }
  }
}

Modelo de dados

O objeto Viagem.

Uma viagem é a unidade de pontuação. Esses são os campos lidos pela maioria das integrações — o esquema completo está nos documentos de referência.

CampoDescrição
tripIdStable identifier for the trip.
overallScoreAURA score for the trip, 0–100. Higher is safer.
tierDerived band: Critical (<45), Fair (<65), Good (<80), Safe.
mapMatchedWhether the trip was map-matched to the road network.
distanceKmTrip distance in kilometres.
durationMinTrip duration in minutes.
startDateISO 8601 start timestamp.
vehicleVehicle plate or unit identifier.

Convenções

Previsível por design.

Erros

As falhas retornam ok: false com uma string de erro e um status convencional HTTP — 400, 401, 403, 404, 429 ou 500.

Paginação

Os pontos de extremidade da lista pegam page e limit (10–100) e retornam um bloco de paginação com page, limit, totalPages e total.

Escopo da frota

Os escopos do cabeçalho x-fleet-id leem para uma frota. Um escopo incompatível retorna 404 – nunca os dados de outra frota.

Níveis de pontuação

Os níveis são derivados de uma escala: Crítico, Justo, Bom, Seguro — os mesmos níveis em todos os tipos de máquinas.

Construa contra uma sandbox.

Os pilotos qualificados obtêm credenciais de sandbox e documentos de referência. Conte-nos sua superfície de integração e mercados.