店舗向け:自社アプリでデジタルレシートを発行・Webhookで通知するガイド
店舗・ブランドが自社アプリでデジタルレシートをお客様に発行し、Webhookでリアルタイム通知を受け取るまでの手順を解説します。アプリ登録・OAuth・Webhook設定・署名検証をカバーします。
開発者ポータルでできること
レシートローラーの開発者ポータルでできることを概観します。REST APIによるデータ取得・操作、Webhookによるリアルタイムイベント受信を組み合わせて、外部システムから店舗・ユーザーデータを連携できます。
本番運用のベストプラクティス
レシートローラー連携アプリを本番運用するためのベストプラクティス(環境分離、監視、デプロイ、障害対応、ドキュメント整備)を解説します。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
監視と失敗時の対応
レシートローラーWebhookの配信履歴の見方、監視すべき指標とアラート設計、デッドレターの再配信、よくある障害パターンと復旧手順を解説します。
SLA・稼働率と障害時の確認手順
レシートローラーAPIの稼働率目標、ステータスページの確認方法、障害発生時の切り分け手順、サポートエスカレーションの流れを解説します。
レート制限とスロットリング
レシートローラーAPIのレート制限の単位、プラン別の上限、レスポンスヘッダーの読み方、429に当たらないための実装パターンを解説します。
予約管理API(Reservations API)の使い方
レシートローラーの予約管理API(/api/v1/reservations)のガイドです。予約のCRUD・ステータス更新、予約枠(スロット)の取得・作成・一括生成、店舗レイアウトに登録された席(テーブル・個室・カウンター)の取得、予約統計までを解説します。
再送・順序・冪等性の設計
レシートローラーWebhookの再送ポリシー、配信順序が保証されない理由、event_idを使った冪等性の実装、デッドレターの扱い、よくあるアンチパターンを解説します。
User系スコープの審査申請
レシートローラーで一般消費者のデータ(user.* スコープ)を扱うアプリに必要な審査申請の流れ、提出書類、審査基準、審査期間、よくある差し戻し理由を解説します。
Webhookの概要
レシートローラーのWebhookで配信される主要なイベント種別、ポーリングではなくWebhookを使うべき理由、配信形式(HTTPS POST + JSON)、配信保証の考え方を解説します。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
エンドポイントとバージョニング
レシートローラーAPIのベースURL、バージョニング方針、廃止予告の流れ、現行バージョンの確認方法を解説します。
Webhookの登録方法
レシートローラーの開発者ポータルでWebhookエンドポイントを登録する手順、購読イベントの選び方、テスト配信、複数エンドポイントの使い分け、削除と一時停止の方法を解説します。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
SNS Webhookバイパス(LINEなど外部SNSのWebhook転送)
レシートローラーがLINE等のSNSプラットフォームから受け取ったWebhookを、店舗側の同意のもとで開発者アプリへ転送する「SNS Webhookバイパス」機能の仕組み、設定方法、署名の取り扱い、注意点を解説します。
店舗内メディアディスプレイAPI(Display API)の使い方
レシートローラーの店舗内 Android ディスプレイ向け API(/api/v1/displays/*)の概要とペアリング・ハートビート・プレイリスト取得・再生実績報告の手順をまとめます。Android キオスクや店舗サイネージ端末でメディアループを再生するアプリを実装するための入門ガイドです。
OAuthスコープ一覧と利用可否
レシートローラーのOAuth APIで利用できるスコープの一覧と、各スコープがどの種類のアプリに付与されるかを説明します。User系スコープの審査要件、Store系とUser系を混在できない理由、LIFFアプリからの利用方法もカバーします。