Webhookの概要
レシートローラーのWebhookで配信される主要なイベント種別、ポーリングではなくWebhookを使うべき理由、配信形式(HTTPS POST + JSON)、配信保証の考え方を解説します。
利用目的・接続先(POS/EC/分析など)の申告
レシートローラーの開発者ポータルでアプリを登録する際に申告する「利用目的」と「接続先カテゴリ」(POS/EC/分析/CRM/OMS/WMS/SNS/その他)の意味、選び方、変更時の注意、User系スコープ審査との関連を解説します。
アクセストークンの取得と更新
レシートローラーAPIで使うアクセストークンとリフレッシュトークンの取得方法、有効期限、更新手順、エラー時の対処を解説します。
リダイレクトURLの設定
レシートローラーの開発者ポータルで設定するリダイレクトURI(コールバックURL)の役割、登録ルール、開発・本番環境の使い分け、よくあるエラーと対処方法を解説します。
開発者向けヘルプ目次
レシートローラー開発者向けヘルプ目次です。開発者申請、アプリケーション登録、OAuth認証とスコープ、実装ガイド(ウォレットアプリ・店舗向けWebhook・Survey API)、データ領域別ガイド、運用とセキュリティ、コミュニティ、トラブルシューティングまでをまとめています。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
シークレットのローテーションと安全な保管
レシートローラーのクライアントシークレット・Webhookシークレットを安全に運用するためのローテーション計画、新旧並行期間の使い方、保管のベストプラクティスを解説します。
アクセス制御と監査ログ
レシートローラー連携アプリ運用におけるアクセス制御の設計、最小権限、監査ログの取り方、定期レビューの実施方法を解説します。
サポートへの問い合わせ(技術連携)
レシートローラー開発者向けサポートの種類、問い合わせ前のチェックリスト、効率的に解決を進めるための情報添付テンプレートを解説します。
アプリを新規作成する
レシートローラーの開発者ポータルで新しいアプリ(OAuthクライアント)を登録する具体的な手順を説明します。入力項目・バリデーション・作成後のクレデンシャル表示・よくあるエラーまでをカバーします。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
Webhookの登録方法
レシートローラーの開発者ポータルでWebhookエンドポイントを登録する手順、購読イベントの選び方、テスト配信、複数エンドポイントの使い分け、削除と一時停止の方法を解説します。
監視と失敗時の対応
レシートローラーWebhookの配信履歴の見方、監視すべき指標とアラート設計、デッドレターの再配信、よくある障害パターンと復旧手順を解説します。
店舗向け:自社アプリでデジタルレシートを発行・Webhookで通知するガイド
店舗・ブランドが自社アプリでデジタルレシートをお客様に発行し、Webhookでリアルタイム通知を受け取るまでの手順を解説します。アプリ登録・OAuth・Webhook設定・署名検証をカバーします。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
代表的なAPI例
レシートローラーAPIの代表的なエンドポイントの呼び出し例(レシート取得・店舗一覧・商品作成・Webhook登録)をcurlコマンドで紹介します。
エラーコードとリトライ指針
レシートローラーAPIが返すHTTPステータスコードとエラーコードの一覧、リトライすべきケース、リトライ間隔の指針を解説します。
Webhookが届かない
Webhookが受信エンドポイントに届かないときの原因切り分け。エンドポイント設定・購読イベント・到達性・署名検証失敗・ファイアウォールなどを順に確認する手順を解説します。