카택스에서 제공하는 REST API의 내용을 확인하고, 직접 테스트 해볼 수 있는 페이지입니다.
관리자 페이지 ‘시스템 설정’ 메뉴의 REST API 키 사용으로 사용중인 데이터에서 직접 테스트 가능합니다.

카택스 REST API

카택스에 등록된 차량, 사용자 리스트와 상세한 운행 리스트 목록 조회가 가능한 REST API를 제공합니다.
API 기능은 플러스, 프리미엄 등급에서 제공됩니다. (무료 등급 시 API 사용에 제한이 있습니다)
문의사항 발생 시 dev@cartax.biz 로 문의 바랍니다.

사용자 리스트 사용자 리스트 카택스 비즈에 등록된 사용자 정보 호출 API

GET /users

Description 카택스 비즈에 등록된 사용자 정보를 조회합니다.

Successful Response

[
  {
    "userID": "string",
    "userName": "string",
    "userEmail": "string",
    "department": "string",
    "duty": "string"
  }
]

Response Read Users Get [
title: Response Read Users Get
User {
    userID*     string
                title: Userid
    userName*   string
                title: Username
    userEmail   string
                title: Useremail
    department  string
                title: Department
    duty        string
                title: Duty
}]

Parameter

header
x-cartax-api-key*	API key

Response Code

Code	Description	*표기되지 않은 상태 코드는 MDN HTTP 상태 코드를 참고 바랍니다.
200	요청 성공
401	유효하지 않은 키(key)
403	사용 권한 없음 (무료 등급 API 사용 제한)
422	문법 오류

Try it Out

header
x-cartax-api-key*

Result

Code	Description
200	요청 성공

  {
    "code": 200
  }

차량 리스트 카택스 비즈에 등록된 차량 리스트 호출 API

GET /cars

Description 카택스 비즈에 등록된 차량 정보를 조회합니다.

Successful Response

[
  {
    "carNumber": "string",
    "modelName": "string",
    "fuel": "string",
    "fuelEconomy": 0,
    "totalDistance": 0
  }
]

Response Read Cars Get [
title: Response Read Cars Get
Car {
  carNumber*      string
                  title: Carnumber
  modelName*      string
                  title: Modelname
  fuel            string
                  title: Fuel
  fuelEconomy     integer
                  title: Fueleconomy
                  default: 0
  totalDistance   integer
                  title: Totaldistance
                  default: 0
}]

Parameter

header
x-cartax-api-key*	API key

Response Code

Code	Description	*표기되지 않은 상태 코드는 MDN HTTP 상태 코드를 참고 바랍니다.
200	요청 성공
401	유효하지 않은 키(key)
403	사용 권한 없음 (무료 등급 API 사용 제한)
422	문법 오류

Try it Out

header
x-cartax-api-key*

Result

Code	Description
200	요청 성공

{
  "code": 200
}

차량 운행 기록 카택스 비즈로 작성한 운행기록 호출 API

POST /drivings

Description 설정한 parameter 값에 따라 작성된 운행기록을 조회합니다.

Successful Response

[
  {
    "carFullName": "string",
    "modelName": "string",
    "carNumber": "string",
    "purpose": "string",
    "drivingTime": "string",
    "userName": "string",
    "department": "string",
    "duty": "string",
    "distanceTraveled": 0,
    "fromDate": "2022-04-21",
    "fromTime": "2022-04-21T08:32:13.007Z",
    "fromAddress": "string",
    "fromOdometer": 0,
    "toTime": "2022-04-21T08:32:13.007Z",
    "toAddress": "string",
    "toOdometer": 0,
    "fuelCost": 0,
    "tollgateCost": 0,
    "etcCost": 0,
    "memo": "string"
  }
]

Response Read Drivings Post [
title: Response Read Drivings Post
DrivingLog {
  carFullName         string
                      title: Carfullname
  modelName           string
                      title: Modelname
  carNumber           string
                      title: Carnumber
  purpose             string
                      title: Purpose
  drivingTime*        string
                      title: Drivingtime
  userName*           string
                      title: Username
  department*         string
                      title: Department
  duty*               string
                      title: Duty
  distanceTraveled*   integer
                      title: Distancetraveled
  fromDate            string($date)
                      title: Fromdate
  fromTime            string($date-time)
                      title: Fromtime
  fromAddress*        string
                      title: Fromaddress
  fromOdometer*       integer
                      title: Fromodometer
  toTime              string($date-time)
                      title: Totime
  toAddress*          string
                      title: Toaddress
  toOdometer*         integer
                      title: Toodometer
  fuelCost*           integer
                      title: Fuelcost
  tollgateCost*       integer
                      title: Tollgatecost
  etcCost*            integer
                      title: Etccost
  memo*               string
                      title: Memo
}]

Request Body

{
  "startDate": "2022-03-01",
  "endDate": "2022-03-31",
  "userID": "J100_j100",
  "carNumber": "00허0000"
}

DrivingsRequestBody {
  startDate*  string($date)
              title: 시작 날짜
              example: 2022-03-01
  endDate*    string($date)
              title: 종료 날짜
              example: 2022-03-31
  userID      string
              title: 유저 아이디
              maxLength: 50
              minLength: 1
              example: J100_j100
  carNumber   string
              title: 차량 넘버
              maxLength: 8
              minLength: 7
              example: 00허0000     
}

Parameter

header
x-cartax-api-key*	API key

body
startDate*	시작일 (YYYY-MM-DD)
endDate*	종료일 (YYYY-MM-DD) 검색기간은 최대 100일을 초과할 수 없습니다
userId	사용자 아이디
carNumber	차량 번호

Response Code

Code	Description	*표기되지 않은 상태 코드는 MDN HTTP 상태 코드를 참고 바랍니다.
200	요청 성공
400	잘못된 Parameter 정보
401	유효하지 않은 키(key)
403	사용 권한 없음 (무료 등급 API 사용 제한)
422	문법 오류

Try it Out

header
x-cartax-api-key*

body
startDate*
endDate*
userID
carNumber

Result

Code	Description
200	요청 성공

{
  "code": 200
}