SMARTRO API GUIDE

POS
VAN
O2O
PG

Header
추가

Request
추가

Response
추가

1.오더 Agent 서비스 소개

본 서비스는 스마트로 Smile POS (리뉴얼 버전)의 상품 및 테이블을 기반으로 주문 연동이 가능합니다.
서버 to 서버 JSON API 형식으로 주문 요청 전에 가맹점 Smile POS 기초정보를 기준으로 연동됩니다.
서비스 연동을 위한 기본 가이드를 제공하며, 실 연동을 위해서는 별도 협의를 통해 진행되어야 합니다.
담당부서 : 스마트로 POS개발실 / 담당자 메일 : PlatformDevDiv@smartro.co.kr

2.오더 Agent 서비스 연동 준비

사전준비
- 1) 서비스 연동을 위한 API 필수 항목인 STORE_ID, SERVICE_ID는 별도 협의 후 제공합니다.
- 2) 주문 연동은 선불/후불 방식 모두 가능합니다.
- 3) 선불의 경우 파트너사 태블릿에 리더기와 결제앱(VCAT) 연동이 필요하오니 별도 협의를 통해 진행합니다.

기초정보
- 1) 가맹점 테이블, 상품정보 API 조회 후 파트너사측 저장 후 활용 (주기 갱신은 일 1회 권장)
- 2) 정보 변경 시 파트너사 태블릿 관리자 혹은 일반 태블릿 옵션 기능에 버튼 이벤트로 API 활용 바랍니다.
- 3) API 주문을 요청하기 위해서는 Agent 실행 및 POS 프로그램 영업 개시가 준비되어야 합니다.
  - - Agent 및 POS 프로그램에 환경 설정에 대해서는 별도 가이드가 필요합니다.
  - - Agent 및 POS 프로그램 문의는 메일(BizupDiv@smartro.co.kr)로 요청하시기 바랍니다.

3.오더 Agent 서비스 연동 흐름

선불방식
- 1) 스마트로 VCAT 선불 결제 후 "신규주문 등록" API 만으로 결제 정보를 포함하여 요청합니다.
  - ① 태블릿에서 스마트로 VCAT 선불 결제 처리
  - ② 신규주문등록 API 요청
- 2) 취소 및 반품 기능은 POS에서 제공하며, 상품별/금액별 분할 결제가 가능합니다.
- 3) 현금의 경우 점주 혹은 직원에게 수기 (태블릿 관리자 혹은 파트사별 상이)로 확인된 결제완료 후 주문 정보를 전송합니다.

후불방식 요청 및 확인
- 1) 후불 방식의 주문 흐름은 테이블 점유형 방식으로 주문조회 ▷ 신규 or 추가 주문 전송의 흐름입니다.
  - - 실시간 주문조회 API로 테이블 확인하여 점유된 주문이 없으면 ▷ 신규주문등록 API 요청
  - - 실시간 주문조회 API로 테이블 확인하여 점유된 주문이 있으면 ▷ 추가주문등록 API 요청
- 2) POS 상태 및 통신 환경에 따라 성공 응답 지연이 발생할 수 있어 주문 등록 요청 후 실시간 조회 확인 필수
  - - 실시간 주문조회 API로 요청한 주문 결과 확인 (수행주기 5초 단위 권장)
  - - (1차 응답) 태블릿 ▷ 스마트로 서버 주문 전송 API 응답
  - - (2차 응답) 스마트로 서버 주문 ▷ POS 전달 성공 : 접수성공 결과 값은 실시간 주문조회로 확인
  - - 정상 : 1번 내용 참고, 실패 : 2번
  - - O2O서버 <> POS간 통신 상 이슈 사례 : 주문 접수시간 기준으로 60초가 지난 건에 대해서는 POS로 전송 제외
  - - 태블릿측 실시간 조회 시 60초 이후에는 실패 건은 조회에서 제외 ▷ 이후 신규 주문 처리 위함

후불방식 점유 시 참고사항
- - POS 화면에서 테이블의 상태 혹은 결제가 진행되는 경우 테이블이 점유되어 API 주문이 불가합니다.
  - ① 실시간 주문조회 확인
  - ② 신규 or 추가주문 요청
  - ③ 테이블 점유 알림 ▷ 잠시후 재요청

실시간 주문조회 참고사항
- 1) 실시간 주문조회 API는 "주문성공", "주문취소"를 기준으로 조회를 제공합니다.
- 2) 태블릿 주문 요청 시 환경상 이슈로 주문대기 및 실패 건에 대해서는 60초 이전까지만 조회가 가능합니다.
  - - 태블릿 주문건은 60초 이후 조회 내역에서 제외됩니다. 이부분을 태블릿측에서 인지하여 주문 재요청을 진행바랍니다.
  - - 장비 및 통신상 이슈 발생 시 상호간 주문 안정성을 위한 처리 프로세스 정립 필요
  - - 장비 및 통신상 이슈가 아니라면 일반적으로 실패 응답을 제공하고 있습니다.