Ana içeriğe atla
POST
/
v1
/
enroute
/
register
Rota kaydet
curl --request POST \
  --url https://api.iklim.co/v1/enroute/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "origin": {
    "lng": 32.857358,
    "lat": 39.93504
  },
  "destination": {
    "lng": 32.857358,
    "lat": 39.93504
  },
  "departureTime": "2023-11-07T05:31:56Z",
  "distanceMeters": 123,
  "durationSeconds": 123,
  "geometry": {
    "encodedPolyline": "<string>",
    "polylinePrecision": 123,
    "coordinates": [
      {
        "lng": 32.857358,
        "lat": 39.93504
      }
    ]
  },
  "waypoints": [
    {
      "lng": 32.857358,
      "lat": 39.93504
    }
  ]
}
'
{
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expirationTime": "2023-11-07T05:31:56Z",
  "distanceUnit": "<string>",
  "status": {
    "progressPercentage": 123,
    "distanceTraveled": 123,
    "remainingDistance": 123,
    "timeElapsedSeconds": 123,
    "estimatedTimeRemainingSeconds": 123,
    "scheduleDeviationSeconds": 123,
    "expectedSegmentIndex": 123,
    "estimatedArrivalTime": "2023-11-07T05:31:56Z"
  },
  "currentSegment": {
    "index": 123,
    "h3Address": "<string>",
    "eta": "2023-11-07T05:31:56Z",
    "etd": "2023-11-07T05:31:56Z",
    "distanceToEntry": 123,
    "distanceToExit": 123,
    "arrivalPoint": {
      "lng": 32.857358,
      "lat": 39.93504
    },
    "departurePoint": {
      "lng": 32.857358,
      "lat": 39.93504
    },
    "weatherEvents": {
      "temperature": 123,
      "apparentTemperature": 123,
      "humidity": 123,
      "cloudCover": 123,
      "windSpeed": 123,
      "windGust": 123,
      "windDirection": 123,
      "snowFall": 123,
      "precipitation": 123,
      "precipitationProbability": 123,
      "visibility": 123,
      "lightningSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "totalEventCount": 123,
        "cgFlashCount": 123,
        "icPulseCount": 123,
        "lastEventAgeSec": 123,
        "lastFlashAgeSec": 123,
        "lastPulseAgeSec": 123,
        "nearestEventDistance": 123,
        "nearestFlashDistance": 123,
        "nearestPulseDistance": 123,
        "maxPeakCurrent": 123,
        "avgPeakCurrent": 123,
        "avgSensorCount": 123,
        "confidenceScore": 123,
        "confidenceLevel": "LOW",
        "riskIndex": 123,
        "riskLevel": "NONE",
        "trend": "UNKNOWN"
      },
      "thunderstormSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "summary": {
          "stormCount": 123,
          "activeStorms": 123,
          "insideAnyThreatBoundary": true,
          "nearestThreatBoundaryDistance": 123,
          "nearestStormCentroidDistance": 123,
          "maxSeverity": "LOW",
          "lastEventAge": 123,
          "riskScore": 123,
          "riskLevel": "NONE",
          "trend": "RISING"
        },
        "activeStorms": [
          {
            "eventId": "<string>",
            "severity": "LOW",
            "eventStartUtcEpoch": 123,
            "eventEndUtcEpoch": 123,
            "eventAge": 123,
            "cell": {
              "area": 123,
              "speed": 123,
              "direction": 123,
              "centroidDistance": 123,
              "directionFromDriver": "N",
              "bearingFromDriver": 123
            },
            "flashRates": {
              "inCloud": 123,
              "cloudToGround": 123,
              "total": 123,
              "cloudToGroundRatio": 123
            },
            "threat": {
              "insideThreatPolygon": true,
              "distanceToThreatBoundary": 123,
              "directionFromDriver": "N",
              "bearingFromDriver": 123,
              "approachState": "APPROACHING"
            },
            "score": {
              "stormRiskScore": 123,
              "stormRiskLevel": "NONE"
            }
          }
        ]
      },
      "precipitationSummary": {
        "windowMinutes": 123,
        "bucketMinutes": 123,
        "currentIntensity": "DRIZZLE",
        "isPrecipitating": true,
        "radarTimeStamp": 123,
        "dataAgeSec": 123,
        "radarSnapshotCount": 123,
        "maxIntensity": "DRIZZLE",
        "trend": "INCREASING",
        "riskLevel": "NONE",
        "forecastMaxIntensity": "DRIZZLE",
        "expectedEndSec": 123,
        "expectedStartSec": 123
      }
    }
  },
  "upcomingSegments": [
    {
      "index": 123,
      "h3Address": "<string>",
      "eta": "2023-11-07T05:31:56Z",
      "etd": "2023-11-07T05:31:56Z",
      "distanceToEntry": 123,
      "distanceToExit": 123,
      "arrivalPoint": {
        "lng": 32.857358,
        "lat": 39.93504
      },
      "departurePoint": {
        "lng": 32.857358,
        "lat": 39.93504
      },
      "weatherEvents": {
        "temperature": 123,
        "apparentTemperature": 123,
        "humidity": 123,
        "cloudCover": 123,
        "windSpeed": 123,
        "windGust": 123,
        "windDirection": 123,
        "snowFall": 123,
        "precipitation": 123,
        "precipitationProbability": 123,
        "visibility": 123
      }
    }
  ]
}

Gövde

application/json
origin
object
gerekli

Rotanın başlangıç noktası

destination
object
gerekli

Rotanın bitiş noktası

departureTime
string<date-time>
gerekli

Planlanan kalkış zamanı, Unix epoch milisaniye cinsinden

distanceMeters
integer<int32>
gerekli

Toplam rota mesafesi, metre cinsinden

durationSeconds
integer<int32>
gerekli

Beklenen toplam seyahat süresi, saniye cinsinden

geometry
object
gerekli

Rota geometrisi; kodlanmış bir polyline veya koordinat listesi olarak sağlanır

waypoints
object[]

Kullanıcı tanımlı opsiyonel ara duraklar (örneğin yakıt durakları, dinlenme alanları); bunlar semantik duraklar olup H3 algılama için kullanılan yoğun yol koordinatlarından farklıdır

Yanıt

Rota başarıyla kaydedildi

routeId
string<uuid>

Kaydedilen rotaya atanan benzersiz tanımlayıcı

expirationTime
string<date-time>

Rota kaydının son geçerlilik zamanı, Unix epoch milisaniye cinsinden

distanceUnit
string

Bu yanıttaki mesafe değerleri için kullanılan birim

status
object

Sürücünün rota üzerindeki mevcut konum ve ilerleme durumu

currentSegment
object

Sürücünün şu anda bulunduğu rota segmenti

upcomingSegments
object[]

Sürücünün önündeki yaklaşan rota segmentlerinin listesi