본문으로 건너뛰기

인증

Vehicle Data API는 OAuth 2.0 기반의 토큰 인증 방식을 사용합니다. API를 사용하기 위해서는 클라이언트 인증 정보를 기반으로 액세스 토큰(access token)을 발급받아야 하며, 이 토큰을 이후 모든 요청의 Authorization 헤더에 포함시켜야 합니다.

Authorization: Bearer <access_token>

액세스 토큰 발급 절차는 다음과 같습니다.

STEP 1. 클라이언트 정보 확인​

  1. Pleos Playground > My Project에서 Vehicle Data API를 사용할 프로젝트를 선택합니다.
  2. 프로젝트 정보 화면에서 API 탭을 선택합니다.
  3. 클라이언트 ID와 클라이언트 시크릿을 확인합니다.
위험

이 정보는 액세스 토큰을 발급받기 위한 API 호출 시 필요하며, 외부에 노출되지 않도록 유의해야 합니다.

STEP 2. 차량 소유자에게 로그인 요청​

차량 소유자에게 차량 제조사의 로그인 창을 출력해서 로그인 인증을 받아야 합니다.
Login를 호출하여 차량 소유자에게 로그인 창을 출력합니다.

유효한 파라미터로 요청 시 다음 화면이 출력됩니다. 요청 파라미터에 대한 상세한 설명은 Login API 문서를 참조합니다.

STEP 3. Authorization Code 획득​

STEP 2에서 차량 소유자가 로그인을 성공하면, STEP 2의 요청 파라미터로 보냈던 로그인 리다이렉트 URL(redirectUrl)로 authorization code(code)가 반환됩니다.

STEP 4. 액세스 토큰 요청​

STEP 3에서 받은 authorization code(code) 값을 파라미터로 Create Access Token를 호출하여 액세스 토큰을 생성합니다.

curl
curl -X POST "https://api.pleos.ai/v1/auth/token" \
  -H "Content-Type: application/json" \
  -H "Brand: hyundai" \
  -d '{
    "clientId": "<YOUR_CLIENT_ID>",
    "clientSecret": "<YOUR_CLIENT_SECRET>",
    "code": "<AUTHORIZATION_CODE>",
    "redirectUrl": "https://www.example.com/auth/hyundai"
  }'
  • clientId: Pleos Playground 프로젝트의 클라이언트ID
  • clientSecret: Pleos Playground 프로젝트의 클라이언트 시크릿
  • code: STEP 3에서 받은 코드
  • redirectUrl: Pleos Playground 프로젝트의 API 사용 신청 시 입력한 OAuth 로그인 > 로그인 리다이렉트 URL
주의

액세스 토큰은 발급 후 1시간만 유효합니다.

액세스 토큰 갱신​

액세스 토큰의 유효기간은 1시간이고, 리프레시 토큰의 유효기간은 90일간입니다.
만료된 액세스 토큰을 갱신하려면 Refresh Access Token를 호출합니다.

curl
curl -X POST "https://api.pleos.ai/v1/auth/token-refresh" \
  -H "Content-Type: application/json" \
  -H "Brand: hyundai" \
  -d '{
    "clientId": "<YOUR_CLIENT_ID>",
    "clientSecret": "<YOUR_CLIENT_SECRET>",
    "refreshToken": "<YOUR_REFRESH_TOKEN>"
  }'
주의

리프레시 토큰은 1회만 사용할 수 있으며, 액세스 토큰 갱신 시마다 새로운 리프레시 토큰이 발급됩니다.