Webhookの登録方法
開発者ポータルの画面とAPIでWebhookを登録する手順、購読イベントの選び方、テスト送信、変更・一時停止・削除の方法を説明します。
Webhookが届かない
Webhookが届かないときに、テスト送信と配信ログで原因を切り分け、無効化・購読イベント・接続・署名検証を順に確認する手順です。
Webhookの概要
実際に送信されるWebhookイベント、届くリクエストの形と署名ヘッダー、重複・順序・取りこぼしの扱い、APIとの使い分けを説明します。
Webhookで新しい売上を受け取り、Slackに通知する
receipt.created Webhookを登録し、Node.jsで署名検証と重複除去をしてSlackに売上を投稿するまでを手順で説明します。
SNS Webhookバイパス(LINEなど外部SNSのWebhook転送)
レシートローラーがLINE等のSNSプラットフォームから受け取ったWebhookを、店舗側の同意のもとで開発者アプリへ転送する「SNS Webhookバイパス」機能の仕組み、設定方法、署名の取り扱い、注意点を解説します。
シークレットのローテーションと安全な保管
レシートローラーのクライアントシークレット・Webhookシークレットを安全に運用するためのローテーション計画、新旧並行期間の使い方、保管のベストプラクティスを解説します。
監視と失敗時の対応
Webhookの有効状態・最終送信日時・配信ログの見方と、自動で無効になったことに気づいて復旧し、抜けた期間をAPIで補う方法を説明します。
再送・順序・冪等性の設計
Webhookの成功条件と再送の規則(1分・10分・1時間、最大4回)、順序と取りこぼし、X-RR-Deliveryで重複を除く受信側の作り方を説明します。
署名検証とセキュリティ
X-RR-Signatureの計算方法とNode.js・Python・C#の検証コード、リプレイへの備え、Webhookシークレットの入れ替え方を説明します。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
在庫データ連携
レシートローラーの在庫データの構造、複数倉庫管理、入出庫履歴、Webhookによるリアルタイム同期、WMS連携パターンを解説します。
購買・レシートデータ連携
レシートローラーが扱う購買・レシートデータの構造、取得方法、関連スコープ、Webhook、よくあるユースケースを解説します。
店舗向け:自社アプリでデジタルレシートを発行・Webhookで通知するガイド
店舗・ブランドが自社アプリでデジタルレシートをお客様に発行し、Webhookでリアルタイム通知を受け取るまでの手順を解説します。アプリ登録・OAuth・Webhook設定・署名検証をカバーします。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
SLA・稼働率と障害時の確認手順
レシートローラーAPIの稼働率目標、ステータスページの確認方法、障害発生時の切り分け手順、サポートエスカレーションの流れを解説します。
商品マスター(PIM)・カテゴリデータ
レシートローラーの商品マスター(PIM)・カテゴリ・バリエーションのデータ構造、CRUD操作、SKU管理、ECとの同期パターンを解説します。
アプリを新規作成する
ビジネスアカウントに開発者アプリを登録する手順を、入力項目、クレデンシャルの表示、作成後にできること、よくあるつまずきまで説明します。
レート制限とスロットリング
レシートローラーAPIでリクエスト数の制限があるエンドポイントと上限、429の返り方、クライアント側の流量の抑え方とリトライ方針を説明します。
開発者ポータルでできること
レシートローラーの開発者ポータルでできることを概観します。REST APIによるデータ取得・操作、Webhookによるリアルタイムイベント受信を組み合わせて、外部システムから店舗・ユーザーデータを連携できます。
OAuthスコープ一覧と利用可否
レシートローラーのOAuth APIで利用できるスコープの一覧と、各スコープがどの種類のアプリに付与されるかを説明します。User系スコープの審査要件、Store系とUser系を混在できない理由、LIFFアプリからの利用方法もカバーします。