開発者向けヘルプ目次
レシートローラー開発者向けヘルプ目次です。開発者申請、アプリケーション登録、OAuth認証とスコープ、実装ガイド(ウォレットアプリ・店舗向けWebhook・Survey API)、データ領域別ガイド、運用とセキュリティ、コミュニティ、トラブルシューティングまでをまとめています。
開発者ポータルでできること
レシートローラーの開発者ポータルでできることを概観します。REST APIによるデータ取得・操作、Webhookによるリアルタイムイベント受信を組み合わせて、外部システムから店舗・ユーザーデータを連携できます。
プランがフリーのまま開発者ポータルが表示されない
レシートローラーの開発者ポータルが表示されない場合の確認手順。プランがフリーの場合の対処方法、組織切り替え、表示反映タイミングを解説します。
利用開始までの流れ
レシートローラーの開発者ポータル利用開始までの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請なしですぐにアプリ登録とAPI実装を始められます。
店舗向け:自社アプリでデジタルレシートを発行・Webhookで通知するガイド
店舗・ブランドが自社アプリでデジタルレシートをお客様に発行し、Webhookでリアルタイム通知を受け取るまでの手順を解説します。アプリ登録・OAuth・Webhook設定・署名検証をカバーします。
APIリファレンスとドキュメントの見方
レシートローラーの開発者向けドキュメントの構成と使い分けを説明します。APIトップページ・Swaggerベースの完全リファレンス・開発者コミュニティの3つの入り口と、それぞれをどう使い分けるかを案内します。
SNS Webhookバイパス(LINEなど外部SNSのWebhook転送)
レシートローラーがLINE等のSNSプラットフォームから受け取ったWebhookを、店舗側の同意のもとで開発者アプリへ転送する「SNS Webhookバイパス」機能の仕組み、設定方法、署名の取り扱い、注意点を解説します。
リダイレクトURLの設定
レシートローラーの開発者ポータルで設定するリダイレクトURI(コールバックURL)の役割、登録ルール、開発・本番環境の使い分け、よくあるエラーと対処方法を解説します。
サポートへの問い合わせ(技術連携)
レシートローラー開発者向けサポートの種類、問い合わせ前のチェックリスト、効率的に解決を進めるための情報添付テンプレートを解説します。
アプリを新規作成する
レシートローラーの開発者ポータルで新しいアプリ(OAuthクライアント)を登録する具体的な手順を説明します。入力項目・バリデーション・作成後のクレデンシャル表示・よくあるエラーまでをカバーします。
User系スコープでapp_not_approvedが返る
User系スコープを使うとapp_not_approvedエラーが返る場合の確認手順。サンドボックス枠での開発、審査申請、サンドボックス本番化の流れを解説します。
Webhookの登録方法
レシートローラーの開発者ポータルでWebhookエンドポイントを登録する手順、購読イベントの選び方、テスト配信、複数エンドポイントの使い分け、削除と一時停止の方法を解説します。
購買・レシートデータ連携
レシートローラーが扱う購買・レシートデータの構造、取得方法、関連スコープ、Webhook、よくあるユースケースを解説します。
利用目的・接続先(POS/EC/分析など)の申告
レシートローラーの開発者ポータルでアプリを登録する際に申告する「利用目的」と「接続先カテゴリ」(POS/EC/分析/CRM/OMS/WMS/SNS/その他)の意味、選び方、変更時の注意、User系スコープ審査との関連を解説します。
利用できるデータ領域
レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
在庫データ連携
レシートローラーの在庫データの構造、複数倉庫管理、入出庫履歴、Webhookによるリアルタイム同期、WMS連携パターンを解説します。
アプリケーション登録とは
レシートローラーのアプリケーション登録の概念を説明します。OAuthクライアントとしてアプリを登録することで、クライアントID・シークレット・リダイレクトURIが発行され、API・Webhook連携を始められます。
商品マスター(PIM)・カテゴリデータ
レシートローラーの商品マスター(PIM)・カテゴリ・バリエーションのデータ構造、CRUD操作、SKU管理、ECとの同期パターンを解説します。
帳票・請求関連データ(対応範囲)
レシートローラーが扱う帳票・請求関連データの対応範囲、税率レポート、インボイス制度対応、会計ソフト連携の指針を解説します。