본문으로 건너뛰기

Vehicle Data API 호출

Vehicle Data API 호출 절차를 예제를 들어 설명합니다.

API URL​

Vehicle Data API의 URL은 인증을 위한 URL, 차량 데이터 조회 및 차량 연결 동의/철회를 위한 URL 2개를 제공합니다.

인증
https://security-api.pleos.ai
차량 데이터 조회, 차량 연결 동의 및 철회
https://api.pleos.ai

Vehicle Data API의 헤더는 Authorization API의 헤더와 Vehicle Data API의 헤더로 구분됩니다.

Authorization API Header​

파라미터타입설명필수 여부
Content-Typestringapplication/jsonOptional
Brandstring차량 브랜드(hyundai/kia/genesis)Required

Vehicle Data API Header​

파라미터타입설명필수 여부
AuthorizationstringBearer accessTokenRequired
Content-Typestringapplication/jsonOptional
Brandstring차량 브랜드(hyundai/kia/genesis)Required

Vehicle Data API 호출​

Vehicle Data API는 별도 호출 순서 없이 개별 API를 단독으로 호출할 수 있습니다. 단, 액세스 토큰을 먼저 발급받고 이후에 Vehicle Data API를 호출해야 합니다.

  1. 액세스 토큰 발급 API 호출
  2. 액세스 토큰 획득 후 API 요청 헤더에 포함
  3. Vehicle Data API 호출 및 결과 확인
    • 차량 배터리 충전 상태를 조회하려면 https://api.pleos.ai/v1/vehicles/{vin}/batteries API 호출
    curl
    curl -X GET "https://api.pleos.ai/v1/vehicles/{vin}/batteries" \
    -H "Authorization: Bearer <your_access_token>" \
    -H "Content-Type: application/json" \
    -H "Brand: hyundai"

응답 메시지​

성공 시 응답 메시지 포맷​

성공 시 응답 메시지 포맷
{
  "data": {
    "ignition": {
      "status": "on",
      "ignitionDetails": [
        {
          "type": "ign1",
          "status": "on"
        },
        {
          "type": "ign3",
          "status": "on"
        },
        {
          "type": "acc",
          "status": "on"
        }
      ]
    },
    "sleepMode": "off",
    "odometer": {
      "value": 6549.2,
      "unit": "km"
    },
    "transmission": {
      "parkingPosition": false
    },
    "timestamp": "2025-09-01T09:10:00Z"
  },
  "meta": {
    "code": 200,
    "message": "Success",
    "success": true,
    "timestamp": "2025-09-01T11:00:00Z",
    "requestId": "835bdbd4-1105-4a8c-b438-a1b2c3d4f5g6"
  }
}

실패 시 응답 메시지​

정보

실패 시 응답 메시지 포맷에 대한 설명은 Error Response를 참조합니다.