Guides
Guides
Start typing to search…

매출 데이터 연동(API)

워크인사이트 API를 이용한 매출 데이터 연동에 대해서 알아봅니다

시작하기 전에

WalkInsights의 API를 사용하기 위해서는 별도의 API 인증을 진행하여야 합니다.

인증에 대한 자세한 방법은 본문 API 인증 문서를 참고해주세요.

📘

용어의 정의

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

Step1. External Key 등록하기

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

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

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

❗️

External Key가 변경되었을 경우

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

❗️

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

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

Step2. 워크인사이트 API를 통해 매출 데이터 반영하기

Step 1에서 External Key의 등록을 마쳤다면 이제 워크인사이트 API를 이용하여 매출 데이터를 반영할 수 있습니다.

먼저 브랜드 정보를 알기 위해 다음과 같이 API를 요청합니다

GET
https://api.walkinsights.com/api/v1/brands

headers
x-user-email: YOUR_EMAIL
x-user-token: YOUR_AUTHENTICATION_TOKEN

요청하게 되면 아래와 같은 형식으로 응답이 오게 됩니다

{
  "brands": [
    {
      "id": 123,
      "name": "WalkInsights",
      ...
    },
   ]
}

위 응답에서 brands에 있는 object의 id를 brand_id라고 하고,
name을 brand_name이라고 하겠습니다.

이제 brand_id와 brand_name 그리고 External Key를 이용해서 브랜드에 등록된 매장의 External Key의 목록을 가져올 수 있습니다.

GET
https://api.walkinsights.com/api/v1/brands/:brand_id/shops/external?vendor=BRAND_NAME&vendor_key=EXTERNAL_KEY

headers
x-user-email: YOUR_EMAIL
x-user-token: YOUR_AUTHENTICATION_TOKEN

응답이 위와 같이 오게 되고 External Key가 WI01 이라면,

다음과 같이 요청할 수 있습니다.

GET
https://api.walkinsights.com/api/v1/brands/123/shops/external?vendor=WalkInsights&vendor_key=WI01

headers
x-user-email: YOUR_EMAIL
x-user-token: YOUR_AUTHENTICATION_TOKEN

요청하게 되면 응답으로 매장의 정보를 받을 수 있습니다.

{
  "shop": {
    "id": 40,
    "name": "WalkInsights Office",
  }
}

그럼 이제 SHOP ID를 응답온 json object의 id에서 가지고 올 수 있습니다.

이제 이 SHOP ID를 이용해서 매출 데이터를 업로드 할 수 있습니다.

업로드할 데이터를 다음과 같이 가정하겠습니다.

매출이 일어난 날짜: 2019-01-01
총 매출액: 3,000,000 (원)
총 판매개수(혹은 전표건수): 300 (개/ea)
통화단위 : KRW (원)

이 상황일 경우 다음과 같이 API 요청을 하면 됩니다.

POST
https://api.walkinsights.com/api/v1/shops/:shop_id/sales_stats_dailies

body
{
  "sales_stats_daily": {
    "date": "2019-01-01",
    "amount": 3000000,
    "quantity": 300,
    "amount_currency": "KRW"
  }
}


headers
x-user-email: YOUR_EMAIL
x-user-token: YOUR_AUTHENTICATION_TOKEN
Content-Type: application/json

이제 올리고자 한 매출 데이터가 워크인사이트의 매장 매출데이터에 반영이 되었습니다.

❗️

매출 데이터 반영시 주의할 점

매출 데이터를 반영할 때에는 반드시 일별로 반영해야 합니다.
하루치의 매출액과 개수로 반영하여야 하며, 건별로 반영할시에는 덮어쓰기가 되기 때문에 데이터가 잘못 반영될 수 있습니다.

Updated 8 months ago

What’s Next