본문으로 건너뛰기

로그인 API

1. 개요​

키오스크 장비에서 KIOSK I/F 시스템 사용을 위해 장비 정보를 전송하고 세션 키를 수신받는 로그인 API입니다.
로그인 실패 시 키오스크 프로그램을 사용할 수 없습니다.


※ 본 API에서 사용되는 키오스크 지점번호, 기기번호, 로그인 ID/PW, IP 주소는 사전 정의되어 있어야 합니다.

1.1 키오스크 동작 정리​

로그인 API의 응답 값에 따라서 키오스크의 화면 구성 및 기능 제어가 결정됩니다.

  • kioskFuncType
    → 도심환급/환급전표 발행 화면 표출 여부가 결정됩니다.
  • minIssueAvailAmt (최소 전표발행 판매금액)
    → 영수증 스캔 시 환급전표 발급 가능 여부가 결정됩니다.
  • issueMethods (발행 시, 동시 제공 가능한 환급 방법)
    → 발행 / 환급 메뉴가 Display 결정됩니다.
  • refundMethods (환급 시, 동시 제공 가능한 환급 방법)
    → 환급시 노출되는 지불 방법이 Display 됩니다.

2. API 기본 정보​

항목값
업무구분로그인
URL/api/v1/login
프로토콜HTTPS
요청방식POST
생성일2020. 3. 10

3. 요청 정보​

3.1 요청 헤더​

필드ID필드명데이터타입필수길이설명
msgSendYmd메시지 전송 일자StringM8메시지 전송 일자
(YYYYMMDD, 예: 20170123)
msgSendHms메시지 전송 시각StringM6메시지 전송 시각
(hhmmss, 예: 185612)
kioskBranchId키오스크 지점번호StringM1~8키오스크 지점 번호
kioskDeviceId키오스크 기기번호StringM1~12키오스크 기기 번호

3.2 요청 바디​

필드ID필드명데이터타입필수길이설명
loginId로그인 아이디StringM1~30키오스크 로그인 ID
loginPwd로그인 비밀번호StringM1~256키오스크 로그인 비밀번호
ipAddrIP 주소StringM1~20IP 주소

3.3 요청 예시​

{
  "header": {
    "msgSendYmd": "20170205",
    "msgSendHms": "125701",
    "kioskBranchId": "0001",
    "kioskDeviceId": "A010"
  },
  "body": {
    "loginId": "kioskLoginId",
    "loginPwd": "12345678",
    "ipAddr": "127.0.0.1"
  }
}

4. 응답 정보​

4.1 응답 헤더​

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

4.2 응답 바디​

필드ID필드명데이터타입필수길이설명
kioskType키오스크 타입StringM1E: Early
L: LAND
A: AIR
kioskFuncType키오스크 기능 유형StringM201: 환급
10: 발행
11: 환급 + 발행
minIssueAvailAmt최소 전표발행 금액StringM1~12동일매장 최소 전표발행 판매금액
maxRfndAvailAmt최대방출금액StringM1~12키오스크 1회 최대방출금액
maxPurchDtAmt구매한도금액StringM1~12도심환급 1회 구매한도금액
issueMethods발행 시 동시 제공 가능한 환급 방법String[]M1~20코드정의
CASH,CREDITCARD,ALIPAY

(예:["CREDITCARD", "ALIPAY"])
refundMethods환급 시 동시 제공 가능한 환급 방법String[]M1~20코드정의
CASH,CREDITCARD,ALIPAY

(예:["CASH", "ALIPAY"])
supportDebitCardType담보인증 지원 카드 목록ObjectM-담보인증 지원 카드 목록
└ visaYnVISA 지원 여부StringM1Y / N
└ masterYnMASTER 지원 여부StringM1Y / N
└ cupYnCHINA UNIONPAY(은련) 지원여부StringM1Y / N
└ jcbYnJCB 지원 여부StringM1Y / N
└ amexYnAMEX 지원 여부StringM1Y / N
└ dciYnDINERS CLUB INTERNATIONAL 지원여부StringM1Y / N
supportRfndCardType환급 지원카드 종류 목록ObjectM-환급 지원카드 종류 목록
└ visaYnVISA 지원 여부StringM1Y / N
└ masterYnMASTER 지원 여부StringM1Y / N
└ cupYnCHINA UNIONPAY(은련) 지원여부StringM1Y / N
└ jcbYnJCB 지원 여부StringM1Y / N
└ amexYnAMEX 지원 여부StringM1Y / N
└ dciYnDINERS CLUB INTERNATIONAL 지원여부StringM1Y / N
cntryInfoList국가 정보 목록ArrayM-국가 정보 배열
└ cntryInfo국가 정보ObjectM-개별 국가 정보 객체
ㅤ└ cntryNm국가명StringM1~60예: Republic of Korea
ㅤ└ cntryCd국가코드StringM1~3ISO 3166-1 alpha-3 (예: KOR)
ㅤ└ cntryCallPrefix국제전화 앞자리StringM1~6예: 82
vroInfo환급사 정보ObjectM-환급사 관련 정보
└ vroAddr환급사 주소StringM300환급사 주소
└ vroPhoneNo환급사 전화번호StringM20환급사 연락처

4.3 응답 예시​

{
  "header": {
    "msgSendYmd": "20170205",
    "msgSendHms": "125701",
    "kioskBranchId": "0001",
    "kioskDeviceId": "A010",
    "loginSesKey": "ABCDEF1234567890",
    "langCd": "ko",
    "respCd": "00000",
    "respMsg": "정상"
  },
  "body": {
    "kioskType": "E",
    "kioskFuncType": "11",
    "minIssueAvailAmt": "30000.00",
    "maxRfndAvailAmt": "3000000.00",
    "maxPurchDtAmt": "5000000.00",
    "issueMethods": ["CREDITCARD", "ALIPAY"],
    "refundMethods": ["CASH", "CREDITCARD", "ALIPAY"],
    "supportDebitCardType": {
      "visaYn": "Y",
      "masterYn": "Y",
      "cupYn": "N",
      "jcbYn": "Y",
      "amexYn": "N",
      "dciYn": "N"
    },
    "supportRfndCardType": {
      "visaYn": "Y",
      "masterYn": "Y",
      "cupYn": "N",
      "jcbYn": "Y",
      "amexYn": "N",
      "dciYn": "N"
    },
    "cntryInfoList": [
      {
        "cntryNm": "Republic of Korea",
        "cntryCd": "KOR",
        "cntryCallPrefix": "82"
      },
      {
        "cntryNm": "Japan",
        "cntryCd": "JPN",
        "cntryCallPrefix": "81"
      },
      {
        "cntryNm": "China",
        "cntryCd": "CHN",
        "cntryCallPrefix": "86"
      }
    ],
    "vroInfo": {
      "vroAddr": "17, Eunhaeng-ro, Yeongdeungpo-gu, Seoul, Republic of Korea",
      "vroPhoneNo": "+82-2-2187-2700"
    }
  }
}