시작하기 전에

본 문서는 워크인사이트의 매출데이터 연동을 SFTP(Secure File Transfer Protocol)을 활용하여 하는 방법에 대해서 설명하고 있습니다.

SFTP 뿐만이 아니라 매출 데이터 연동(API) 또한 별도의 가이드 문서를 통하여 지원하고 있으니 참고부탁드립니다.

Java를 이용하실경우 SFTP 연동을 진행하신다면, Java 8 이상의 환경을 추천드립니다

📘

용어의 정의

워크인사이트에서 관리하고 있는 매장 ID를 SHOP ID 라고 하며,
워크인사이트가 아닌 고객사에서 관리하고 있는 매장 ID를 External Key 라고 합니다.

❗️

SFTP를 통한 매출연동의 제약사항

SFTP를 통한 매출연동을 진행할 때는 다음과 같은 제약사항이 있습니다.

1. AWS 기반의 SFTP 서버를 제공하므로 DNS 기반의 화이트리스트가 가능해야함

Step 1. External Key 등록하기

매출연동을 진행하기 위해서는 External Key 를 반드시 등록하여야 합니다.

External Key는 워크인사이트에서는 알 수가 없기 때문에,
워크인사이트에서 관리하고 있는 매장 ID와 연결을 하여야 합니다.

이 연결 작업을 하기 위해서는
External Key 및 그 매장의 이름
워크인사이트 측에 전달해주셔야 합니다.

❗️

External Key가 변경되었을 경우

만약 External Key가 변경되었을 경우 반드시 워크인사이트측에 통보 및 데이터를 전달해주셔야 합니다

❗️

External Key를 등록하는 과정에 대해서

이 과정은 매출연동을 하기 위해서는 반드시 선행되어야 하는 과정입니다.
이 과정이 누락될경우 매출연동을 진행할 수 없습니다.

Step2. SFTP를 이용하여 매출데이터 반영하기

Step1에서 External Key의 등록을 마쳤다면 이제 SFTP를 이용하여 매출 데이터 반영을 진행할 수 있습니다.

SFTP를 활용한 매출 데이터는 CSV 포맷을 통하여 진행되며 포맷은 다음과 같습니다.

File Format

• Header를 포함한 CSV 포맷이며 구분자는 ;을 사용
• 인코딩은 UTF-8
• 파일 Naming Rule
  - 브랜드이름_날짜.csv
  - 단 브랜드이름은 대문자로 이루어짐
  파일 제목 Example

WALKINSIGHTS_20190101.csv
WALKINSIGHTS_20190102.csv
WALKINSIGHTS_20190103.csv

파일 내용 Example

external_key;date;sales_amount;sales_count
WI1111;20171114;92000;3
WI1112;20171114;59000;2

CSV의 header는 external_key;date;sales_amount;sales_count 순으로 이루어져 있어야 합니다.

위의 포맷 및 예제를 참고하셔서 파일을 SFTP에 업로드 해주시면 됩니다.

컬럼들

❗️

SFTP 준비에 대하여

SFTP 연동을 위한 SFTP 서버 준비는 영업일 기준 2~3일의 시간이 소요되며, 준비가 완료되었을 시 메일을 통하여 알려드립니다