Webhookの概要
レシートローラーのWebhookで配信される主要なイベント種別、ポーリングではなくWebhookを使うべき理由、配信形式(HTTPS POST + JSON)、配信保証の考え方を解説します。
アプリケーション登録とは
レシートローラーのアプリケーション登録の概念を説明します。OAuthクライアントとしてアプリを登録することで、クライアントID・シークレット・リダイレクトURIが発行され、API・Webhook連携を始められます。
開発者ポータルでできること
レシートローラーの開発者ポータルでできることを概観します。REST APIによるデータ取得・操作、Webhookによるリアルタイムイベント受信を組み合わせて、外部システムから店舗・ユーザーデータを連携できます。
開発者向けヘルプ目次
レシートローラー開発者向けヘルプ目次です。開発者申請、アプリケーション登録、OAuth認証とスコープ、実装ガイド(ウォレットアプリ・店舗向けWebhook・Survey API)、データ領域別ガイド、運用とセキュリティ、コミュニティ、トラブルシューティングまでをまとめています。
APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。APIトップページ・Swaggerベースの完全リファレンス・開発者コミュニティの3つの入り口と、それぞれをどう使い分けるかを案内します。
在庫データ連携
レシートローラーの在庫データの構造、複数倉庫管理、入出庫履歴、Webhookによるリアルタイム同期、WMS連携パターンを解説します。
アプリを新規作成する
レシートローラーの開発者ポータルで新しいアプリ(OAuthクライアント)を登録する具体的な手順を説明します。入力項目・バリデーション・作成後のクレデンシャル表示・よくあるエラーまでをカバーします。
署名検証とセキュリティ
レシートローラーWebhookのHMAC-SHA256署名検証の仕組み、検証コードのサンプル(Node.js / Python / C#)、リプレイ攻撃対策、シークレットの安全な管理方法を解説します。
Webhookの登録方法
レシートローラーの開発者ポータルでWebhookエンドポイントを登録する手順、購読イベントの選び方、テスト配信、複数エンドポイントの使い分け、削除と一時停止の方法を解説します。
再送・順序・冪等性の設計
レシートローラーWebhookの再送ポリシー、配信順序が保証されない理由、event_idを使った冪等性の実装、デッドレターの扱い、よくあるアンチパターンを解説します。
SNS Webhookバイパス(LINEなど外部SNSのWebhook転送)
レシートローラーがLINE等のSNSプラットフォームから受け取ったWebhookを、店舗側の同意のもとで開発者アプリへ転送する「SNS Webhookバイパス」機能の仕組み、設定方法、署名の取り扱い、注意点を解説します。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
監視と失敗時の対応
レシートローラーWebhookの配信履歴の見方、監視すべき指標とアラート設計、デッドレターの再配信、よくある障害パターンと復旧手順を解説します。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。