본문으로 건너뛰기

키오스크 상태 정보 API

1. 개요​

시내환급 키오스크의 소프트웨어 및 하드웨어 각 상태에 대한 상세 오류 코드를 전달하는 API입니다.
기기 최초 기동 시 및 매 10분 간격으로 상태 정보를 전송합니다.

2. API 기본 정보​

항목값
업무구분키오스크 상태 정보
URL/api/v1/kioskStatus
프로토콜HTTPS
요청방식POST
생성일2020. 3. 10

3. 요청 정보​

3.1 요청 헤더​

필드ID필드명데이터타입필수길이설명
msgSendYmd메시지 전송 일자StringM8메시지 전송 일자
(YYYYMMDD, 예: 20170123)
msgSendHms메시지 전송 시각StringM6메시지 전송 시각
(hhmmss, 예: 185612)
kioskBranchId키오스크 지점번호StringM1~8키오스크 지점번호
kioskDeviceId키오스크 기기번호StringM1~12키오스크 기기번호
loginSesKey세션 키StringM1~50로그인 전문 응답에서 취득

3.2 요청 바디​

필드ID필드명데이터타입필수길이설명
software소프트웨어 정보ObjectM-소프트웨어 상태 정보
└ loginStatus로그인 상태StringM10: 정상
1: 비정상
hardware하드웨어 정보ObjectM-하드웨어 상태 정보
└ thermalPrinter써멀프린터 상태ObjectM-써멀프린터 상태
ㅤ└ printError인쇄 오류 상태StringM10: 정상
1: 비정상
ㅤ└ port포트 상태StringM10: 정상
1: 비정상
ㅤ└ noPaper용지 부족 여부StringM10: 정상
1: 비정상
ㅤ└ nearEnd용지 거의 다됨StringM10: 정상
1: 비정상
ㅤ└ headOpen프린터 헤드 열림StringM10: 정상
1: 비정상
ㅤ└ etcError기타 오류StringM10: 정상
1: 비정상
└ cash방출기 상태ObjectM-지폐 방출기 상태
ㅤ└ port포트 상태StringM10: 정상
1: 비정상
ㅤ└ errorCode오류 코드StringM200: 정상
그 외 오류 코드
ㅤ└ errorMessage오류 메시지StringM200에러 메시지
└ coin동전 방출기 상태ObjectM-동전 방출기 상태
ㅤ└ port포트 상태StringM10: 정상
1: 비정상
ㅤ└ errorCode오류 코드StringM200: 정상
그 외 오류 코드
ㅤ└ errorMessage오류 메시지StringM200에러 메시지
└ passport여권 리더기 상태ObjectM-여권 리더기 상태
ㅤ└ port포트 상태StringM10: 정상
1: 비정상
ㅤ└ errorCode오류 코드StringM200: 정상
그 외 오류 코드
ㅤ└ errorMessage오류 메시지StringM200에러 메시지
└ barcode바코드 리더기 상태ObjectM-바코드 리더기 상태
ㅤ└ port포트 상태StringM10: 정상
1: 비정상
ㅤ└ errorCode오류 코드StringM200: 정상
그 외 오류 코드
ㅤ└ errorMessage오류 메시지StringM200에러 메시지
└ cardReader카드 리더기 상태ObjectM-카드 리더기 상태
ㅤ└ port포트 상태StringM10: 정상
1: 비정상
ㅤ└ errorCode오류 코드StringM200: 정상
그 외 오류 코드
ㅤ└ errorMessage오류 메시지StringM200에러 메시지

3.3 요청 예시​

{
  "header": {
    "msgSendYmd": "20170205",
    "msgSendHms": "125701",
    "kioskBranchId": "0001",
    "kioskDeviceId": "A010",
    "loginSesKey": "ABCDEF1234567890",
    "langCd": "kr"
  },
  "body": {
    "software": {
      "loginStatus": "1"
    },
    "hardware": {
      "thermalPrinter": {
        "printError": "0",
        "port": "0",
        "noPaper": "0",
        "nearEnd": "0",
        "headOpen": "0",
        "etcError": "0"
      },
      "cash": {
        "port": "0",
        "errorCode": "0",
        "errorMessage": "에러 메시지"
      },
      "coin": {
        "port": "0",
        "errorCode": "0",
        "errorMessage": "에러 메시지"
      },
      "passport": {
        "port": "0",
        "errorCode": "0",
        "errorMessage": "에러 메시지"
      },
      "barcode": {
        "port": "0",
        "errorCode": "0",
        "errorMessage": "에러 메시지"
      },
      "cardReader": {
        "port": "0",
        "errorCode": "0",
        "errorMessage": "에러 메시지"
      }
    }
  }
}

4. 응답 정보​

4.1 응답 헤더​

필드ID필드명데이터타입필수길이설명
msgSendYmd메시지 전송 일자StringM8메시지 전송 일자
(YYYYMMDD, 예: 20170123)
msgSendHms메시지 전송 시각StringM6메시지 전송 시각
(hhmmss, 예: 185612)
kioskBranchId키오스크 지점번호StringM1~8키오스크 지점번호
kioskDeviceId키오스크 기기번호StringM1~12키오스크 기기번호
loginSesKey세션 키StringM1~50로그인 전문 응답에서 취득
langCd키오스크 언어StringM2키오스크 UI 선택 언어
respCd응답코드StringM5문자 5글자 (예: 00000)
respMsg응답메시지StringM0~250응답 메시지

4.2 응답 바디​

응답 바디 없음

4.3 응답 예시​

{
  "header": {
    "msgSendYmd": "20170205",
    "msgSendHms": "125701",
    "kioskBranchId": "0001",
    "kioskDeviceId": "A010",
    "loginSesKey": "ABCDEF1234567890",
    "langCd": "kr",
    "respCd": "00000",
    "respMsg": "정상"
  },
  "body": null
}