取引取得に伴うAPIコール数の設定について

カテゴリ: POS

こんにちは。

現在以下の方法によって取引明細を1時間ごとに取得しようと考えております。

  1. /transactions で取引IDを取得
  2. 取引IDごとの明細を /transactions/{id} で取得

上記の方法の場合、APIコール数が「店舗数」×「各店舗の1時間あたりのレジ会計数」となり、ある程度の顧客ターゲット像があるといえど、必要APIコール数が顧客ごとに変動するためプラン設定をすることが難しいかと思っております。


取引明細を全件取得するとした場合に、上記以外に考えられる方法はなにかありますでしょうか?主に以下の方法が考えられるかと思っていますが、developerの方が実際に運用している他の方法などあれば教えていただけますと助かります。

  • スマレジアプリマーケットにて、APIコール数の上限に違いを持たせた松竹梅のプランを用意する
  • 取引明細csv作成で対応(昨年実績なども取り込む場合はこの方法になりますでしょうか?)


また、コール必要数がプラン内の制限を超えた場合はどういった挙動になるかも教えていただけますと幸いです。

答え

  • @高田海斗

    お問い合わせありがとうございます。

    こちら、ご質問いただいている内容のうち、「取引APIを利用する際のAPIコール数上限」に関するご質問について取り急ぎ回答させていただきます。

    コール数の上限を超えた際の挙動につきましては回答に今しばらくお時間を頂戴いたします。誠に申し訳ございません。


    まず、冒頭に高田様がご記載の通り、全ての取引を取引取得APIを利用して同期することは、コール数の問題で不可能になります。

    その上でご質問いただいております、

    取引明細を全件取得するとした場合に、上記以外に考えられる方法はなにかありますでしょうか?主に以下の方法が考えられるかと思っていますが、developerの方が実際に運用している他の方法などあれば教えていただけますと助かります。

    こちらでご提示いただいております二つの方法ですと、

    取引明細CSV作成で対応

    こちらをお勧めいたします。(過去実績の取り込みに限らず、1時間ごとにこちらをコールしていただく想定)

    スマレジアプリマーケットにて、APIコール数の上限に違いを持たせた松竹梅のプランを用意する

    こちらについては、コール数の上限がきますとアプリ自体の機能が制限されますがこの挙動についてエンドユーザが正しく認識できないケースも想定されます。そのため、コール数を節約し安定的に機能提供できる取引明細CSV作成APIをご利用いただく方が、リリース後の運用まで考慮しますと安全かと存じます。

    ただ、取引明細CSV作成APIは非同期実行であり、生成されたCSVのダウンロードとインポート処理も別途作成が必要になります。そのため、こちらの実装上の問題点や質問事項などございましたら、別途ご質問いただけますと幸いでございます。

  • 詳細にありがとうございます。

    取引明細CSV作成で対応してみます。実装に関してまた質問させていただくことがあるかもしれませんが、よろしくお願いいたします。