APIを使う理由
アプリの通常動作は、商品スキャン時に商品情報と価格情報を、商品選択時に商品ジャンル情報とインストア商品情報を、精算時に買い物カートの内容をフリレジサーバーに送受信します。この方法では、商品点数が多い店舗様や価格情報の変更が頻発する店舗様では、フリレジサーバーへのマスタ更新回数が増加する傾向にあり、維持管理にかかる運用コストが追加で必要になることが想定されます。フリレジでは、運用時の負担を軽減する目的でアプリから店舗様が提供するAPIをコールバックする手段を備えています。
二重管理を回避
店舗様のサーバーとフリレジのサーバーで同一の商品情報や価格情報を保持することを回避します。双方に同一情報を保持することはデータ管理をより複雑かつ煩雑にします。
情報漏洩を防止
店舗様独自の価格情報をフリレジサーバーに保持することは、情報漏洩のリスクを僅かに上げます。(自社で管理できない以上、リスクが全くないとは言い切れません)
運用コスト増を回避
店舗様のサーバーとフリレジサーバーのデータを同期するためにシステム担当者が運用対応を行うことで発生する運用コストを回避します。
シンプルなシステムを維持
フリレジを介さないのでシステムをシンプルな構成にします。
APIを使うべきか
APIを使うメリットは大きいですが、利用には多少の専門知識と設備が必要です。貴社が定める情報資産の管理方針やシステム構築の体制等により判断すると良いでしょう。以下のサンプルを参考に、総合的に判断してください。
取り扱い商品
取り扱い商品が1,000点を超える
商品の更新が日に100点を超える
価格の更新が日に300点を超える
商品・価格の更新が月に10,000点を超える
1つ以上該当ならAPI利用を推奨
情報セキュリティ
情報を他社のサーバーに保存できない
APIを公開できる
全て該当ならAPI利用を推奨
システム知識
情報システム部門がある
RESTful APIの知識がある
APIを構築できる
既存システムと連携する（できる）
全て該当ならAPI利用を推奨
運用コスト
初期導入に費用をかけられる
データ更新に費用をかけたくない
維持管理に人手をかけたくない
1つ以上該当ならAPI利用を推奨
PULL APIの呼び出し
貴店のAPIを登録しておくことで、フリレジはAPIをコールバックしてデータを取得します。あらかじめ設定した上で、正しく動作するか確認する必要があります。
※送信するパラメータおよび返却する項目名や属性は決まっています。
ソースマーキング商品
バーコード(JAN)の付いた商品の情報を取得するためにAPIをコールバックします。このAPIをコールバックするタイミングは、お客様が商品バーコードをスキャンした時です。APIは商品に関する情報（名称、写真URL、価格等）を返却する必要があります。
インストア商品(NLP)
店舗様独自のバーコード(先頭20〜29ではじまる）の付いた商品の情報を取得するためにAPIをコールバックします。このAPIをコールバックするタイミングは、お客様が商品バーコードをスキャンした時です。APIは商品に関する情報（名称、写真URL等）を返却する必要があります。
※APIから返却される価格を優先して使用しますが、返却値に含まれない場合にはバーコードの価格を使用します。
商品ジャンル
商品選択ページの商品ジャンルを取得するためにAPIをコールバックします。このAPIをコールバックするタイミングは、お客様が商品選択ページを開く時です。APIは商品ジャンルに関する情報（名称、写真URL等）を返却する必要があります。
インストア商品
バーコード(JAN)が付いてない商品情報を取得するためにAPIをコールバックします。このAPIをコールバックするタイミングは、お客様が商品選択ページを開く時です。APIは商品に関する情報（名称、写真URL、価格等）を返却する必要があります。
PUSH APIの呼び出し
貴社のAPIを登録しておくことで、フリレジはAPIをコールバックしてデータを送信します。あらかじめ設定した上で、正しく動作するか確認する必要があります。
※送信する項目名や属性は決まっています。
精算データ
精算対象の商品情報を送信するためにAPIをコールバックします。このAPIをコールバックするタイミングは、お客様がカート内の商品を精算し会計する時です。
※カゴ落ちの情報も送信できます。
PULL PRODUCT FOR API
お客様が貴店で商品のバーコードをスキャンした時に、貴社のAPIをコールバックして商品情報を取得します。ソースマーキング用のAPIを設定し、商品情報を返却する必要があります。
HTTP GET
https://your-domain/your-source-marking-api?barcode=4900000000000&key=your-api-key
FIELDS RETURNED BY API
PULL PRODUCT(NLP) FOR API
お客様が貴店で商品の独自バーコードをスキャンした時に、貴社のAPIをコールバックして商品情報を取得します。インストアマーキング用のAPIを設定し、商品情報を返却する必要があります。
HTTP GET
https://your-domain/your-in-store-marking-api ?barcode=2000000900009&key=your-api-key
FIELDS RETURNED BY API
PULL PRODUCT GENRE FOR API
お客様がバーコードのない商品を選択する時に、貴社のAPIをコールバックして商品ジャンル情報を取得します。商品ジャンルのAPIを設定し、商品ジャンル情報を返却する必要があります。
HTTP GET
https://your-domain/your-product-genre-api ?key=your-api-key
FIELDS RETURNED BY API
PULL PRODUCTS(GENRE) FOR API
お客様がバーコードのない商品を選択する時に、貴社のAPIをコールバックして商品情報を取得します。インストア商品のAPIを設定し、商品情報を返却する必要があります。
HTTP GET
https://your-domain/your-products-api ?genre=genreID&key=your-api-key
FIELDS RETURNED BY API
PUSH PAYMENT FOR API
お客様が貴店で精算を行う時に、貴店のAPIをコールバックし精算情報を送信します。貴店の精算レジにデータを転送するなど、会計前のシステム連携にご利用いただけます。
HTTP POST
https://your-domain/your-payment-api
ご質問がありますか?
APIサービスの詳細についてご質問のある方は、以下のフォームにご記入ください。
