기기상태 API
1. 개요
장비 기동 시 전문을 전송하는 API 입니다.
기기 사용 중 매 ‘X’분마다 키오스크 상태를 확인하고 전송해야 합니다.
2. API 기본 정보
| 항목 | 값 |
|---|---|
| 업무구분 | 기기상태 |
| URL | /api/v1/kioskStatInfo |
| 프로토콜 | HTTPS |
| 요청방식 | POST |
| 생성일 | 2020. 3. 10 |
3. 요청 정보
3.1 요청 헤더
| 필드ID | 필드명 | 데이터타입 | 필수 | 길이 | 설명 |
|---|---|---|---|---|---|
| msgSendYmd | 메시지 전송 일자 | String | M | 8 | 메시지 전송 일자 (YYYYMMDD, 예: 20170123) |
| msgSendHms | 메시지 전송 시각 | String | M | 6 | 메시지 전송 시각 (hhmmss, 예: 185612) |
| kioskBranchId | 키오스크 지점번호 | String | M | 1~8 | 키오스크 지점번호 |
| kioskDeviceId | 키오스크 기기번호 | String | M | 1~12 | 키오스크 기기번호 |
| loginSesKey | 세션 키 | String | M | 1~50 | 로그인 전문 응답에서 취득 |
3.2 요청 바디
| 필드ID | 필드명 | 데이터타입 | 필수 | 길이 | 설명 |
|---|---|---|---|---|---|
| loginStat | 로그인 상태 | String | M | 1 | 로그인 상태 |
| supervisorMode | supervisor mode | String | M | 1 | supervisor 모드 |
| balance50000 | 5만원 지폐 출금부 | String | M | 1 | 5만원권 출금부 상태 |
| balance10000 | 1만원 지폐 출금부 | String | M | 1 | 1만원권 출금부 상태 |
| balance5000 | 5천원 지폐 출금부 | String | M | 1 | 5천원권 출금부 상태 |
| balance1000 | 1천원 지폐 출금부 | String | M | 1 | 1천원권 출금부 상태 |
| balance500 | 500원 동전 출금부 | String | M | 1 | 500원 동전 출금부 상태 |
| balance100 | 100원 동전 출금부 | String | M | 1 | 100원 동전 출금부 상태 |
| balanceRecpt | 명세표 부족 | String | M | 1 | 명세표 부족 상태 |
| balanceDummy | dummy | String | M | 10 | dummy |
| errRecpt | 명세표 에러 | String | M | 1~6 | 명세표 에러 |
| errCardreader | 카드 리더기 에러 | String | M | 1~6 | 카드 리더기 에러 |
| errPassreader | 여권 리더기 에러 | String | M | 1~6 | 여권 리더기 에러 |
| errBarcoderead | 바코드 리더기 에러 | String | M | 1~6 | 바코드 리더기 에러 |
| errCashOutlet | 지폐 출금부 에러 | String | M | 1~6 | 지폐 출금부 에러 |
| errCoinOutlet | 동전 출금부 에러 | String | M | 1~6 | 동전 출금부 에러 |
| errDummy | dummy | String | M | 1~20 | dummy |
| programVer | 프로그램 버전 | String | M | 1~10 | 프로그램 버전 |
| kioskSerialNo | 기기 시리얼 번호 | String | M | 1~20 | 기기 시리얼 번호 |
3.3 요청 예시
{
"header": {
"msgSendYmd": "20170205",
"msgSendHms": "125701",
"kioskBranchId": "0001",
"kioskDeviceId": "A010",
"loginSesKey": "ABCDEF1234567890",
"langCd": "ko",
"respCd": "",
"respMsg": ""
},
"body": {
"loginStat": "0",
"supervisorMode": "0",
"balance50000": "0",
"balance10000": "0",
"balance5000": "0",
"balance1000": "0",
"balance500": "0",
"balance100": "0",
"balanceRecpt": "0",
"balanceDummy": "",
"errRecpt": "030000",
"errCardreader": "080000",
"errPassreader": "0B000",
"errBarcodereader": "050000",
"errCashOutlet": "040000",
"errCoinOutlet": "070000",
"errDummy": "",
"programVer": "0.0.1",
"kioskSerialNo": "99"
}
}
4. 응답 정보
4.1 응답 헤더
| 필드ID | 필드명 | 데이터타입 | 필수 | 길이 | 설명 |
|---|---|---|---|---|---|
| msgSendYmd | 메시지 전송 일자 | String | M | 8 | 메시지 전송 일자 (YYYYMMDD, 예: 20170123) |
| msgSendHms | 메시지 전송 시각 | String | M | 6 | 메시지 전송 시각 (hhmmss, 예: 185612) |
| kioskBranchId | 키오스크 지점번호 | String | M | 1~8 | 키오스크 지점번호 |
| kioskDeviceId | 키오스크 기기번호 | String | M | 1~12 | 키오스크 기기번호 |
| loginSesKey | 세션 키 | String | M | 1~50 | 로그인 전문 응답에서 취득 |
| respCd | 응답코드 | String | M | 5 | 문자 5글자 (예: 00000) |
| respMsg | 응답메시지 | String | M | 0~250 | 응답 메시지 |
4.2 응답 바디
응답 바디 없음
4.3 응답 예시
{
"header": {
"msgSendYmd": "20170205",
"msgSendHms": "125701",
"kioskBranchId": "0001",
"kioskDeviceId": "A010",
"loginSesKey": "ABCDEF1234567890",
"langCd": "",
"respCd": "00000",
"respMsg": "정상"
},
"body": null
}