API認証ガイド
OAuth 2.0 認可コードフローでの認証方法を、認可URLのパラメーター、同意画面、トークン交換・取り消し、エラー、スコープまで解説します。
ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
iOS・Android・LINE Mini Appなどのウォレット型アプリから、ユーザーの同意のもとで Receipt Roller の購買レシートを取得する方法を解説します。OAuth 2.0認証・レシートAPI・Webhook連携をカバーします。
アクセストークンの取得と更新
アクセストークン(8時間)とリフレッシュトークン(30日)の取得・更新の手順、更新ごとの入れ替わり、使えなくなるケースを説明します。
トークンが取得できない(認証エラー)
トークンエンドポイントが400/401を返すときの切り分け方。invalid_client、invalid_grant などのエラーと error_description ごとの対処を解説します。
アプリを新規作成する
ビジネスアカウントに開発者アプリを登録する手順を、入力項目、クレデンシャルの表示、作成後にできること、よくあるつまずきまで説明します。
リダイレクトURLの設定
開発者アプリに1つ登録するリダイレクトURIの役割、完全一致のルール、環境ごとの分け方、変更の手順、よくあるエラーを解説します。
OAuthスコープ一覧と利用可否
レシートローラーのOAuth APIで利用できるスコープの一覧と、各スコープがどの種類のアプリに付与されるかを説明します。User系スコープの審査要件、Store系とUser系を混在できない理由、LIFFアプリからの利用方法もカバーします。
クライアントID・クライアントシークレットの管理
クライアントIDとクライアントシークレットの確認場所、保管のルール、漏えい時の再生成、複数環境での運用を説明します。
リクエストとレスポンスの基本(JSON)
レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
403/401が返る(権限・スコープ)
API呼び出しで401や403が返るときの原因切り分け。トークン無効・スコープ不足・店舗アクセス権なし・User系審査未通過などの典型ケースを解説します。
はじめてのAPI呼び出し:アプリ登録から取引一覧の取得まで
OAuth認可コードフロー(PKCE)でトークンを取得し、ビジネスアカウントを確認して取引一覧を取得、トークンを更新するまでを通して行います。
エラーコードとリトライ指針
レシートローラーAPIのエラー時のステータスコードと本文の形、トークンエンドポイントのエラー、送り直してよいケースと方法を説明します。
エンドポイントとバージョニング
レシートローラーAPIのベースURL、バージョニング方針、廃止予告の流れ、現行バージョンの確認方法を解説します。
店舗情報API(Store Information API)の使い方
店舗の基本情報(店舗名・店舗種別・連絡先・住所)を取得・更新する REST API のガイドです。スタッフアプリなどのトークン認証クライアントから店舗情報の編集を実装できます。
開発者向けヘルプ目次
レシートローラー開発者向けヘルプ目次です。開発者申請、アプリケーション登録、OAuth認証とスコープ、実装ガイド(ウォレットアプリ・店舗向けWebhook・Survey API)、データ領域別ガイド、運用とセキュリティ、コミュニティ、トラブルシューティングまでをまとめています。
ストアアプリ コンテンツAPI(お知らせ・ページ・営業情報)の使い方
ストアアプリのコンテンツ(お知らせ・ページ・マニフェスト・営業情報・会員証設定)を取得する /api/v1/apps/{shopId}/* の使い方です。shopId はビジネスアカウント ID と同一であること、ビジネスアカウント単位コンテンツと店舗単位コンテンツの違い、認証の扱いを解説します。