更新履歴

最終更新日: 2021/05/03

1. 概要

POS連携APIはPOSへ注文を行うことができる。

POS連携APIをご利用して頂くには、まず初めに弊社とクライアントで契約をし、弊社側でPOS連携APIを利用するためのアカウントを作成する必要がある。このアカウントはクライアントに対して発行される。

POS連携APIは弊社のクラウドサーバへリクエストが届くため、POSへ直接リクエストを行うわけではない。

各APIの詳細に関してはblayn POS連携API 仕様 を参照。

1.1 用語の定義

1.2 アカウント情報

2. POS連携APIの流れ

2.1 認証

POS連携用のAPIは認証にOAuth2を利用しているため、事前にアクセストークンを取得する必要がある。

アクセストークンの取得後は、以下のHTTPヘッダを付与しAPIをコールすること。なお、アクセストークンの値はURLエンコード処理を行う必要はない。

Authorization: <access_token>

2.2 店舗コード

POSでは店舗を識別するためにshop_codeという店舗識別コードを発行している。これは店舗固有のユニーク値となっており、クライアント側はshop_codeを登録できるインターフェースを提供する必要がある。

2.3 マスターデータの連携

POSではいくつかのマスターデータが存在し、POS連携APIのパラメータとして必須になるケースが存在する。これらのデータは店舗側がPOSへコードを登録する。データの同期をするためには、CSVファイルでの同期とAPI経由での同期の2種類を提供している。

CSVファイルでの同期
店舗側は弊社のWeb管理画面からCSVファイルをダウンロードすることで、商品コードやテーブルコードなどを参照することができる。クライアント側はこれらのコードを登録できるインターフェイスを提供する必要がある。

API経由での同期

APIで各データを取得することができる。詳細はblayn POS連携API 仕様 を参照。

同期の方法はクライアント側の実装に任せる。

2.3.1 マスターデータの種類

• 部門データ
• 商品データ
• テーブルデータ
• 商品詳細データ
• 商品詳細の商品データ

2.3.2 CSVファイルのサンプル

文字コード: Shift_JIS
ファイル命名規則: linkage_[クライアント名]_[ファイル種別].csv

例
クライアント名: blayn
ファイル種別: category_item
ファイル名: linkage_blayn_category_item.csv

category_item

table

item_detail