본문으로 건너뛰기

Getting started

시작하기​

Fleet API는 REST API와 Webhook을 제공하여 사용자가 쉽게 Fleet을 다룰 수 있도록 합니다. 차량과 단말의 기본 정보부터 실시간 데이터, 차량 제어, 운전자, 차량 정비, 이상 상태 등의 요소들을 사용자가 원하는 플랫폼에 원하는 방식으로 자유롭게 연동할 수 있습니다.

API 엔드포인트 정보​

API 엔드포인트 정보는 Pleos Fleet 사용 계약 후에 담당자를 통해 제공합니다. 엔드포인트별 역할은 다음과 같습니다.

  • FLEET_API_GATEWAY_HOST : Fleet API에 접근하기 위해 필요한 토큰을 획득할 수 있는 게이트웨이 호스트
  • FLEET_API_HOST : Fleet API의 호스트

REST API 시작하기​

아래 안내된 순서를 통해 REST API를 활용하여 Fleet API의 요소들을 다룰 수 있습니다.

  1. Pleos Playground를 통해 Client ID와 Client Secret, Project ID를 발급받습니다.
  2. Fleet API 사용 신청을 통해 사용 승인을 받습니다.
  3. 사용 승인이 되면 REST API를 사용할 수 있습니다.

인증 토큰 발급받기​

Fleet API는 Client Credentials Grant 인증을 지원합니다. 이전에 발급받은 Client ID와 Client Secret, Project ID를 통해 token을 발급을 요청합니다.

요청 엔드포인트 정보​
MethodEndpoint
POST${FLEET_API_GATEWAY_HOST}/auth/client/token
요청 본문 (JSON)​
{
  "client_id": "your-client-id", // Pleos Playground에서 발급받은 Client ID
  "secret": "your-secret", // Pleos Playground에서 발급받은  Client Secret
  "identifier": "your-project-id", // Pleos Playground에서 발급받은 Project ID
  "regenerate_token": false // 토큰 재발행 여부(true일 경우 유효한 기존 토큰이 있어도 기존 토큰을 무효화하고 무조건 신규로 발행합니다)
}
요청 응답​
AccessToken: {Your.Access.Token}, // 발급받은 Access Token
AccessTokenExpireInSecond: 3600 // 발급받은 Access Token이 발급 시점으로부터 만료되는 시간(second)
Fleet API 요청 예시​

위에서 발급받은 액세스 토큰을 가지고 Fleet API를 호출할 수 있습니다. 다음은 Fleet API를 활용해 차량 목록을 조회하는 예입니다.

curl -X GET "${FLEET_API_HOST}/developers/api/vehicles?page=1&size=20" \
     -H "x-42dot-client-id: Bearer Your.Access.Token"

이제 Fleet API에서 제공하는 요소를 마음껏 다룰 수 있게 되었습니다!

Fleet API에서 제공하는 REST API에 대한 자세한 정보는 Fleet REST API Overview를 참고하세요.

Webhook 시작하기​

Fleet 이벤트를 실시간으로 수신하고 싶으시다면 Fleet API의 Webhook을 사용할 수 있습니다.

  1. Fleet API 사용 승인을 받았다면, Pleos Fleet에서 설정 > Webhook 메뉴에 접근할 수 있습니다. 해당 메뉴로 접근합니다.
  2. 우측 상단의 Webhook 등록 버튼을 통해 새로운 Webhook을 등록합니다.
  3. 원하는 Webhook 이벤트를 선택합니다.
  4. 이벤트가 발생했을 때 데이터를 수신받고자 하는 Endpoint를 입력합니다.
  5. (Optional) Endpoint의 종류에 따라 Custom Header의 사용이 필요할 수 있습니다. 필요한 Custom Header를 등록합니다.
  6. 모든 정보가 입력되었다면 [등록] 버튼을 클릭하여 Webhook을 등록합니다.

이제 원하는 Fleet 이벤트를 실시간으로 수신할 수 있습니다!

Fleet API에서 제공하는 Webhook 이벤트에 대한 자세한 정보는 Fleet API Webhook Overview를 참고하세요.