@nhnpayco-dev/mcp-devcenter 1.0.0

package/dist/data/guides/order-vorder.md

@@ -0,0 +1,326 @@
+# VORDER 연동하기
+
+> **원본:** https://devcenter.payco.com/guide/order/vorder/start?id=220401029
+> **카테고리:** `order-vorder`
+> **포함 단계 (LNB):**
+> - VORDER 연동하기 (`/guide/order/vorder/start?id=220401029`)
+
+---
+
+## VORDER 연동하기 VORDER 소개 및 DLL 함수 안내
+
+VORDER을 통한 연동 상세 내용을 안내합니다.
+
+### 연동 프로세스 이해하기
+
+![VORDER flow 이미지](/img/@vorder_flow.b5ae1727.png)
+
+  
+  
+
+1. #### VORDER 알아보기
+
+   VORDER 파일 구성도를 참고하여 각 파일 별 기능을 확인해 보세요.
+
+   PAYCO VORDER은 Visual Studio 2013 MFC DLL로 제작되었으며, DLL 연동을 위한 [윈도우용 샘플소스](/guide/order/sample?id=220401032)를 제공하고 있습니다.  
+    샘플 소스의 비동기 연동 방식을 참고해주세요.
+
+     
+
+   ![VORDER 파일구성도](/img/@vorder_diagram.c986ea51.png)
+
+   - ##### VORDER 파일 구성
+
+     VORDER 파일명에 관한 설명 테이블
+
+     | 파일명 | 설명 |
+     | --- | --- |
+     | [vORDER_IF.dll](/guide/order/vorder/vorderIfDll?id=220401029) | 오더 연동 DLL 파일입니다. |
+     | vORDER.exe | 주문 승인, 완료, 취소를 할 수 있는 메인 프로그램입니다. |
+     | vORDER_UPDATE.exe | 패키지 업데이트 수행 프로그램입니다. |
+     | vORDER_LOG.exe | 패키지 로그관리 프로그램입니다. |
+     | [VORDER_ENV.ini](/guide/order/vorder/vorderEnv?id=220401029) | 프로그램 환경설정 파일입니다. |
+     | PAYCO_SHOPINFO.ini | 오더 가맹점 정보 파일입니다. 처음 실행하여 가맹점 정보를 입력해주세요. |
+
+     VORDER 패키지 설치를 위해서는 DLL 파일([vORDER_IF.dll](https://paycoscdn.toastoven.net/payco/offline/order/dll/dll-1.5.4.0/vORDER_IF.dll))이 설치되어야 합니다.  
+      관련 프로그램들은 DLL 함수 호출 시에 자동 설치가 됩니다. 함수 호출방법은 [DLL 함수사용](/guide/order/vorder/vorderIfDll?id=220401029)에서 자세히 확인해 보세요.
+   - ##### VORDER_ENV.ini 상세
+
+     VORDER 구동에 필수적으로 참조하는 환경설정 파일입니다. 개발환경 샘플 환경설정 파일은 [여기](https://paycoscdn.toastoven.net/payco/offline/order/env/VORDER_ENV.INI)를 참고해주세요.
+
+     **잠깐만요!**
+
+     운영환경 배포 시에는 반드시 “ENV_MODE : 개발/운영환경 모드값” 을 확인 후 배포해주세요.
+
+     VORDER_ENV.ini 환경설정 옵션 설명 테이블
+
+     | 옵션 그룹 | 옵션 | 설명 | 옵션값 |
+     | --- | --- | --- | --- |
+     | [COMMON] | ENV_MODE | 개발/운영환경 모드 구분 설정 값입니다. | T : 개발환경  R : 운영환경 (default) |
+     | [LOCATION] | POINT_X | 위젯 위치 X좌표입니다. | 0 (default) |
+     | POINT_Y | 위젯 위치 Y좌표입니다. | 0 (default) |
+     | TRANSPARENT_LEVEL | 위젯 투명도 입니다. | 5 : 투명  0 : 불투명 (default) |
+     | [POS] | PROCESS_LIMIT | POS에 전달하는 데이터 개수입니다. | 1 (default) |
+     | WAIT_TIME | POS 타임아웃 시간입니다. | 7 (default) |
+     | SKIP_TIMEOUT | POS 타임아웃 발생 시 수동매출생성 진행 여부 값입니다. | Y (default) |
+     | [WAVE] | volume | “주문이 왔어요” 알람 볼륨 크기입니다. | 50 (default) |
+     | REPEAT_COUNT | “주문이 왔어요” 알람 반복 횟수입니다. | 계속 (default) |
+     | REPEAT_PERIOD | “주문이 왔어요” 알람 반복 주기입니다. | 7 (default) |
+     | [SKIP] | COMPLETE | 완료 시, POS에 이벤트 전달 여부 값입니다. | Y : 이벤트 미전달  N : 이벤트 전달 (default) |
+
+     **VORDER_ENV.ini SAMPLE**
+
+     ```
+     [COMMON]
+     ENV_MODE =R
+     [LOCATION]
+     POINT_X=1188
+     POINT_Y=406
+     TRANSPARENT_LEVEL=0
+
+     [POS]
+     PROCESS_LIMIT = 2
+     WAIT_TIME = 10
+     SKIP_TIMEOUT = Y
+
+     [WAVE]
+     volume=87
+     REPEAT_COUNT=3
+     REPEAT_PERIOD = 7
+
+     [SKIP]
+     COMPLETE = Y
+     ```- ##### 음성(WAV) 파일
+
+     vORDER.exe 가 있는 폴더 안에 ‘VORDER_MENT’ 폴더를 생성하여 원하는 음성 파일로 재생할 수 있어요.  
+      * 해당 파일이 없을 경우 리소스에 등록된 기본 음성 파일이 재생됩니다.
+
+     음성(WAV)파일 설명
+
+     | 음성(wav) 파일명 | 설명 | 음성 예시 |
+     | --- | --- | --- |
+     | order_alarm.wav | 오더 주문 알람 WAV 파일명 | 새로운 주문이 들어왔어요 |
+   - ##### 윈도우 이벤트
+
+     VORDER에서 데이터 생성/변경 시 POS 단말기로 윈도우 이벤트를 전달합니다.  
+      EndEvent 기본값은 36000 입니다.
+
+     윈도우 이벤트 설명
+
+     | EventID | IpData | cbData | 설명 |
+     | --- | --- | --- | --- |
+     | EndEvent | Json Data | Len(lpData + 1) | 결제 종료 시 발생하는 이벤트입니다. |
+     | EndEvent+1 | Json Data | Len(lpData + 1) | 주문 수락 시 발생하는 이벤트입니다.  솔루션에서는 매출 반영 및 주문서와 영수증을 출력해주세요. |
+     | EndEvent+2 | Json Data | Len(lpData + 1) | 주문 완료 시 발생하는 이벤트입니다.  DID(호출기)가 있는 경우 고객을 호출해주세요. |
+     | EndEvent+3 | Json Data | Len(lpData + 1) | 자동 수락 시 발생하는 이벤트입니다.  솔루션에서는 매출 반영 및 주문서와 영수증을 출력해주세요. |
+     | EndEvent+4 | Json Data | Len(lpData + 1) | 메뉴 품절/품절해제하는 이벤트입니다. |
+     | EndEvent+5 | Json Data | Len(lpData + 1) | 전체 메뉴 품절해제하는 이벤트입니다. |
+     | EndEvent+6 | Json Data | Len(lpData + 1) | 취소 처리된 주문건을 다시 POS로 내려드리는 이벤트입니다.  솔루션에서는 매출 취소 반영 및 취소 주문서와 영수증을 출력해주세요. |
+     | EndEvent+101 | Json Data | Len(lpData + 1) | 주문 수락 취소 시 발생하는 이벤트입니다.  솔루션에서는 매출 취소 반영 및 취소 주문서와 영수증을 출력해주세요. |
+     | EndEvent+102 | Json Data | Len(lpData + 1) | 주문서 재출력 이벤트입니다. |
+     | EndEvent+103 | Json Data | Len(lpData + 1) | 영수증 재출력 이벤트입니다. |
+     | EndEvent+104 | Json Data | Len(lpData + 1) | 취소 처리된 주문건의 영수증 재출력 이벤트입니다. |
+   - ##### 윈도우 이벤트 Json Data - EndEvent+4, EndEvent+5
+
+     윈도우 이벤트 JSON Data설명
+
+     | KEY | 타입 | 설명 |
+     | --- | --- | --- |
+     | posNo | String | 메뉴/옵션 코드입니다. |
+     | status | String | 메뉴/옵션 상태입니다.  - SALE : 판매  - SOLD_OUT : 품절 |
+   - ##### 윈도우 이벤트 Json Data - EndEvent+4, EndEvent+5 외
+
+     윈도우 이벤트 EndEvent+4, EndEvent+5 외 설명
+
+     | KEY | 타입 | 설명 |
+     | --- | --- | --- |
+     | no | String | 오더 주문번호 |
+     | ymd | String | 주문일 |
+     | hms | String | 주문시간 |
+     | serviceType | String | 서비스 타입 |
+     | channelType | String | 주문채널 |
+     | channelOrderNo | String | 채널주문번호 |
+     | tableNo | String | 테이블번호 |
+     | desc | String | 주문내역 |
+     | status | String | 주문상태 |
+     | telNo | String | 전화번호 |
+     | reqMemo | String | 요청사항 |
+     | paidBy | String | 결제방식 |
+     | amt | Number | 주문금액 |
+     | discountAmt | Number | 할인금액 |
+     | telNo | Number | 실결제금액 |
+     | billNo | String | 전표번호 |
+     | waitNo | String | 대기번호 |
+     | posShopId | String | POS 매장 Id |
+     | payments[].payType | String | 결제방식 |
+     | payments[].quickPayType | String | 간편결제방식 |
+     | payments[].quota | String | 할부개월 |
+     | payments[].agencyCd | String | 결제기관코드 |
+     | payments[].agencyName | String | 결제기관명 |
+     | payments[].agencyNo | String | 결제식별자번호 |
+     | payments[].tradeNo | String | PG 거래번호 |
+     | payments[].authNo | String | 승인번호 |
+     | payments[].vanRequestNo | String | 클라우드포스 거래요청번호 |
+     | payments[].vanAuthDt | String | 클라우드포스 결제일시 |
+     | payments[].vanReserveOrderNo | String | 클라우드포스 주문예약번호 |
+     | payments[].vanAgency | String | 클라우드포스 결제기관코드 |
+     | payments[].vanAgencyName | String | 클라우드포스 결제기관명 |
+     | payments[].payAmt | String | 결제금액 |
+     | payments[].taxFreeAmt | String | 면세금액 |
+     | payments[].taxableAmt | String | 과세금액 |
+     | payments[].vatAmt | String | 부가세금액 |
+     | payments[].serviceAmt | String | 봉사료 |
+     | discounts[].type | String | 할인유형 |
+     | discounts[].name | String | 할인유형명 |
+     | discounts[].amt | Number | 할인금액 |
+     | discounts[].companyAmt | Number | 사장님 쿠폰 외 쿠폰할인금액 |
+     | discounts[].shopAmt | Number | 사장님 쿠폰 사용시 쿠폰할인금액 |
+     | discounts[].detailType | String | 할인상세유형 |
+     | discounts[].paycoCouponNo | String | 페이코 쿠폰번호 |
+     | discounts[].paycoCouponId | String | 페이코 쿠폰ID |
+     | discounts[].paycoCouponName | String | 페이코 쿠폰명 |
+     | discounts[].usePoint | Number | 사용 포인트 |
+     | discounts[].pointTradeNo | String | 포인트 거래번호 |
+     | discounts[].shopMenuNo | String | 매장 메뉴 NO (할인적용된메뉴확인용) |
+     | discountTargets[].paycoCouponNo | String | 할인대상 페이코 쿠폰번호 |
+     | discountTargets[].posClassCd | String | 할인대상 POS 분류 코드 |
+     | discountTargets[].posMenuCd | String | 할인대상 POS 메뉴코드 |
+     | discountTargets[].amt | Number | 할인금액 |
+     | menus[].shopMenuNo | String | 매장메뉴 NO |
+     | menus[].menuName | String | 메뉴명 |
+     | menus[].menuAmt | Number | 메뉴단가 |
+     | menus[].discountAmt | Number | 매장메뉴할인금액 |
+     | menus[].cnt | Number | 수량 |
+     | menus[].amt | Number | 금액 |
+     | menus[].totAmt | Number | 총금액(옵션포함) |
+     | menus[].posClasscd | String | POS 분류코드 |
+     | menus[].posMenuCd | String | POS 메뉴코드 |
+     | menus[].discountReason | String | 매장할인근거 |
+     | menus[].discountNo | String | 매장메뉴할인번호 |
+     | menus[].shopMenuGroupNo | String | 매장메뉴그룹코드 |
+     | menus[].options[].groupName | String | 매장메뉴옵션명 |
+     | menus[].options[].name | String | 매장메뉴옵션상세명 |
+     | menus[].options[].cnt | Number | 옵션수량 |
+     | menus[].options[].amt | Number | 옵션금액 |
+     | menus[].options[].totAmt | Number | 옵션총금액 |
+     | menus[].options[].posMenuCd | String | 메뉴코드 |
+     | menus[].options[].posClassCd | String | POS메뉴분류코드 |
+     | pickupTime | String | 픽업시간 |
+     | safeTelNo | String | 안심전화번호 |
+     | posMembershipNo | String | 멤버십적립 |
+     | packingFlag | String | 포장 유무( Y : 포장 N: 매장 식사) |
+     | cup | String | 컵 유형입니다. 포장(픽업)시에만 내려갑니다.  MUG : 머그컵  TO_GO : 일회용 컵  NULL : 픽업서비스 외의 서비스 |
+     | nickname | String | 별칭 |
+     | vanCorp | String | VAN사 코드 |
+     | extractMenus[].posClassCd | String | POS 분류 코드 |
+     | extractMenus[].posMenuCd | String | POS 메뉴코드 |
+     | extractMenus[].menuName | String | 메뉴명 |
+     | extractMenus[].menuAmt | String | 메뉴단가 |
+     | extractMenus[].discountAmt | String | 매장메뉴할인금액 |
+     | extractMenus[].options[].posClassCd | String | POS 분류 코드 |
+     | extractMenus[].options[].posMenuCd | String | POS 메뉴코드 |
+     | extractMenus[].options[].groupName | String | 메뉴옵션명 |
+     | extractMenus[].options[].name | String | 메뉴옵션상세명 |
+     | extractMenus[].options[].amt | String | 메뉴옵션단가 |
+     | sourceType | String | 유입경로 |
+     | deliveryAmt | Number | 배달금액 |
+     | addr | String | 배달지 지번주소 |
+     | addrDetail | String | 배달지 지번주소 상세 |
+     | roadAddr | String | 배달지 도로명주소 |
+     | roadAddrDetail | String | 배달지 도로명주소 상세 |
+     | safeTelNo | String | 수령인 안심전화번호 입니다. |
+     | reserveFlag | String | 예약여부 |
+     | latitude | Number | 위도 |
+     | longitude | Number | 경도 |
+     | deliveryInfo.ymd | String | 주문일자 |
+     | deliveryInfo.rider | String | 배달대행업체 |
+     | deliveryInfo.riderName | String | 라이더 이름 |
+     | deliveryInfo.deliveryCode | String | 배달대행서브업체코드 (스파이더) |
+     | deliveryInfo.name | String | 라이더 이름 |
+     | deliveryInfo.telNo | String | 라이더 연락처 |
+     | deliveryInfo.cookingTime | Number | 조리시간(픽업요청시간) |
+     | deliveryInfo.expectTime | Number | 배달예상소요시간 |
+     | deliveryInfo.requestTime | String | 배달요청시간 (yyyyMMddHHmm) |
+     | deliveryInfo.assignedTime | String | 배차완료시간 |
+     | payTime | String | 선불 : IN_ADVANCE  후불 : ON_TIME |
+     | deferPayType | String | 결제수단 (후불일 경우에만 사용) |
+2. #### DLL 함수 사용하기
+
+   DLL 에서 제공하는 함수를 사용하여 오더를 연동해 보세요.
+
+   - ##### vORDER_IF.dll 함수 목록
+
+     vORDER_IF.dll 함수 목록 테이블
+
+     | 함수명 | 리턴값 | 파라미터 | 설명 |
+     | --- | --- | --- | --- |
+     | SetData | void | String, String | 가맹점 정보 등록 시 사용해주세요.  사업자번호, POS ID, orgno 데이터를 반드시 등록해주세요. |
+     | DailyRun | int | Window Handle | 개점 업무 처리 함수입니다. POS 단말기 프로그램 구동 시 실행해주세요. |
+     | SendData | int | String, String | 수락/완료/취소 등 윈도우 이벤트에 대해 POS 데이터를 보내주세요. |
+     | ProcessEnd | int |  | 페이코 서비스를 종료하는 함수입니다. 종료시에만 실행해주세요. |
+   - ##### SetData 상세
+
+     POS에서 보유한 사업자등록번호, 매장고유번호, 포스고유번호를 등록해주세요.  
+      * DailyRun 함수 전에 필히 등록해주세요.
+
+     SetData 상세 목록 테이블
+
+     | KEY | 타입 | 설명 |
+     | --- | --- | --- |
+     | registernumber | String | 사업자번호(대시(-) 제외) |
+     | posid | String | 매장 고유 번호 |
+     | orgno | String | POS 고유 번호 (unique No) |
+
+     **SetData SAMPLE**
+
+     ```
+     SetData(“registernumber”, “1231212345”);
+     SetData(“posid”, “order1”);
+     SetData(“orgno”, “orgno1”);
+     ```- ##### DailyRun 상세
+
+     POS 개점 업무 처리 시 호출해주세요.  
+      DailyRun((int) POS Program Handle);
+   - ##### SendData 상세
+
+     수락, 자동 수락, 완료 시 각각의 윈도우 이벤트를 받으면 POS에서는 적합한 조치를 취한 후 해당 함수를 호출해주세요.  
+      SendData((LPCTSTR)”KEY”, (LPCTSTR)”JSON 데이터“);
+
+     SetData 상세 목록 테이블
+
+     | KEY | 설명 |
+     | --- | --- |
+     | ACCEPTED | 수락 |
+     | ACCEPTED_AUTO | 자동 수락 |
+     | COMPLETED | 완료 |
+     | FAILED | POS 문제 발생 시 |
+   - ##### JSON 데이터 (배열)
+
+     JSON 데이터 (배열)
+
+     | 구분 | KEY | 타입 | 설명 |
+     | --- | --- | --- | --- |
+     | ACCEPTED, ACCEPTED_AUTO, COMPLETED | orderNo | String | 오더 주문번호 입니다. |
+     | ACCEPTED, ACCEPTED_AUTO, COMPLETED | status | String | 수락, 자동 수락, 완료 상태값 입니다. |
+     | ACCEPTED, ACCEPTED_AUTO | waitNo | String | POS 대기번호 입니다. |
+     | FAILED | message | String | POS에서 문제 발생 시 상세 실패 메시지 입니다.  VORDER에서 얼럿으로 노출됩니다. |
+
+     **SendData SAMPLE**
+
+     ```
+     // 수락
+     SendData("ACCEPTED","[{\"orderNo\": \"20210530073713330628\", \"status\": \"ACCEPTED\", \"waitNo\": \"1\"}]");
+
+     // 자동수락
+     SendData("ACCEPTED_AUTO","[{\"orderNo\": \"20210530073713330628\", \"status\": \"ACCEPTED_AUTO\", \"waitNo\": \"1\"}]");
+
+     // 완료
+     SendData("COMPLETED","[{\"orderNo\": \"20210530073713330628\", \"status\": \"COMPLETED\"}]");
+
+     // POS 실패
+     SendData("FAILED","[{\"message\": \"일시적인 문제로 인해 수락/완료 처리를 할 수 없습니다.\"}]");
+     ```- ##### 주문서 및 영수증
+
+     ![배달 주문서 영수증 이미지](/img/@vorder_delivery_receipt.c132248d.png)
+
+     ![픽업 주문서 영수증 이미지](/img/@vorder_pickup_receipt.42fc8cd0.png)

package/dist/data/guides/order-vorder.meta.json

@@ -0,0 +1,24 @@
+{
+  "slug": "order-vorder",
+  "id": "220401029",
+  "url": "https://devcenter.payco.com/guide/order/vorder/start?id=220401029",
+  "path": "/guide/order/vorder/start",
+  "title": "VORDER 연동하기",
+  "menu_text": "VORDER 연동하기",
+  "sections": [
+    {
+      "label": "VORDER 연동하기",
+      "path": "/guide/order/vorder/start",
+      "id": "220401029"
+    }
+  ],
+  "h2_sections": [
+    "VORDER 연동하기 VORDER 소개 및 DLL 함수 안내"
+  ],
+  "h3_sections": [
+    "연동 프로세스 이해하기"
+  ],
+  "table_count": 10,
+  "code_block_count": 3,
+  "text_length": 8758
+}