在庫・リソース・予約分析API の使い方
レシートローラーの予約在庫API(/api/v1/reservations/stock)、リソースAPI(/api/v1/reservations/resources)、予約分析API(/api/v1/reservations/analytics)のガイドです。客室やレンタル品の在庫管理、予約可能な席とスタッフの取得、期間指定の予約分析を解説します。
代表的なAPI例
レシートローラーAPIの代表的なエンドポイントの呼び出し例(レシート取得・店舗一覧・商品作成・Webhook登録)をcurlコマンドで紹介します。
OAuthスコープ一覧と利用可否
レシートローラーのOAuth APIで利用できるスコープの一覧と、各スコープがどの種類のアプリに付与されるかを説明します。User系スコープの審査要件、Store系とUser系を混在できない理由、LIFFアプリからの利用方法もカバーします。
監視と失敗時の対応
Webhookの有効状態・最終送信日時・配信ログの見方と、自動で無効になったことに気づいて復旧し、抜けた期間をAPIで補う方法を説明します。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
通い放題プラン・回数券API の使い方
レシートローラーの通い放題プランAPI(/api/v1/reservations/memberships)と回数券API(/api/v1/reservations/passes)のガイドです。プランと回数券商品の管理、ご加入者・ご購入者の一覧、解約、他システムからの回数券の取り込みまでを解説します。
レート制限とスロットリング
レシートローラーAPIでリクエスト数の制限があるエンドポイントと上限、429の返り方、クライアント側の流量の抑え方とリトライ方針を説明します。
SLA・稼働率と障害時の確認手順
レシートローラーAPIの稼働率目標、ステータスページの確認方法、障害発生時の切り分け手順、サポートエスカレーションの流れを解説します。
Webhookの概要
実際に送信されるWebhookイベント、届くリクエストの形と署名ヘッダー、重複・順序・取りこぼしの扱い、APIとの使い分けを説明します。
エラーコードとリトライ指針
レシートローラーAPIのエラー時のステータスコードと本文の形、トークンエンドポイントのエラー、送り直してよいケースと方法を説明します。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
ストアアプリ コンテンツAPI(お知らせ・ページ・営業情報)の使い方
ストアアプリのコンテンツ(お知らせ・ページ・マニフェスト・営業情報・会員証設定)を取得する /api/v1/apps/{shopId}/* の使い方です。shopId はビジネスアカウント ID と同一であること、ビジネスアカウント単位コンテンツと店舗単位コンテンツの違い、認証の扱いを解説します。
403/401が返る(権限・スコープ)
API呼び出しで401や403が返るときの原因切り分け。トークン無効・スコープ不足・店舗アクセス権なし・User系審査未通過などの典型ケースを解説します。
Webhookで新しい売上を受け取り、Slackに通知する
receipt.created Webhookを登録し、Node.jsで署名検証と重複除去をしてSlackに売上を投稿するまでを手順で説明します。
トークンが取得できない(認証エラー)
トークンエンドポイントが400/401を返すときの切り分け方。invalid_client、invalid_grant などのエラーと error_description ごとの対処を解説します。
本番運用のベストプラクティス
レシートローラー連携アプリを本番運用するためのベストプラクティス(環境分離、監視、デプロイ、障害対応、ドキュメント整備)を解説します。
アクセストークンの取得と更新
アクセストークン(8時間)とリフレッシュトークン(30日)の取得・更新の手順、更新ごとの入れ替わり、使えなくなるケースを説明します。
再送・順序・冪等性の設計
Webhookの成功条件と再送の規則(1分・10分・1時間、最大4回)、順序と取りこぼし、X-RR-Deliveryで重複を除く受信側の作り方を説明します。
Webhookが届かない
Webhookが届かないときに、テスト送信と配信ログで原因を切り分け、無効化・購読イベント・接続・署名検証を順に確認する手順です。