利用開始までの流れ
レシートローラーの開発者ポータルを使い始めるまでの流れを説明します。店舗ユーザーとして登録し、スタータープラン以上であれば、別途の開発者申請は不要です。アプリを登録すればすぐにAPI実装を開始できます。
利用開始までの流れ
レシートローラーの開発者ポータルは、別ドメインの「開発者専用サイト」ではなく、通常の店舗管理画面の中の機能の一つとして提供されています。そのため、「開発者として申請して承認を待つ」という別フローは原則ありません。店舗ユーザーとして登録してプランをアップグレードすれば、その時点から開発者機能が使えます。
3分で全体像
- 店舗ユーザーとして登録 — 通常の店舗アカウント作成と同じ
- プランをスターター以上に — フリープランでは開発者APIは利用不可
- 開発者ポータルでアプリ登録 — クライアントID・シークレットを発行
- OAuth認可フローを実装 — 必要なスコープを指定してトークンを取得
- APIまたはWebhookで実装
個人ユーザーのレシート・支出データ(user.* スコープ)を扱う場合のみ、追加で事前審査が必要になります。詳細は本ページ末尾とOAuthスコープ一覧をご覧ください。
ステップ1:店舗ユーザーとして登録
レシートローラーの通常の店舗アカウントを作成します。すでに店舗ユーザーとして利用中の場合はこのステップはスキップしてください。
- レシートローラーのトップページから「無料ではじめる」を選択し、メールアドレス・パスワード・組織情報を入力します
- 店舗を1つ以上登録します(API連携の対象範囲が「組織」と「店舗」になるため)
- 登録した時点ではフリープランです
店舗アカウント作成の詳細は店舗アカウントの作成(店舗向けヘルプ)をご覧ください。
ステップ2:プランをスターター以上にアップグレード
開発者APIはスタータープラン以上でご利用いただけます。フリープランのままでは、アプリ登録画面に進んでも作成できません。
- 組織メニュー > 組織設定 > プラン・請求 を開きます
- 「アップグレード」からスターター以上のプランを選択し、契約手続きを完了します
- 契約完了と同時に開発者ポータルが解放されます
プランごとに使える機能はプランとロールの関係でご確認ください。
ステップ3:開発者ポータルでアプリを登録
店舗管理画面のメニューから開発者ポータルを開き、新しいアプリケーションを登録します。
- 店舗管理画面のメニューから「デベロッパー」または「開発者ポータル」を開きます
- 「アプリを登録」または「新規アプリ作成」をクリックします
- 以下の情報を入力します:
- アプリ名 — 認可画面でユーザーに表示される名称
- リダイレクトURI — OAuth認可後にコードを返す先のURL(複数登録可)
- 必要なスコープ — このアプリが要求するOAuthスコープ
- 登録するとクライアントIDとクライアントシークレットが発行されます
必ずコピーして安全な場所に保管してください。紛失した場合は再生成が必要です(既存のシークレットは即座に無効になります)。
ステップ4:OAuthスコープを設定
アプリが必要とする最小限のスコープを指定します。スコープの完全な一覧と取得制限はOAuthスコープ一覧と利用可否をご覧ください。
- Store系スコープのみ(
store.*/crm.*/sns.*/analytics.*) → アプリ登録と同時に利用可 - User系スコープを含む(
user.*) → アプリのUserScopeStatusがpendingとなり、運営チームの審査後にapprovedへ
ステップ5:実装
取得したクライアントID・シークレットとリダイレクトURIを使ってOAuth認可フローを実装し、アクセストークンでAPIを呼び出します。Webhookでイベントを受信したい場合は、続けてWebhook URLを登録します。
ユースケース別の実装ガイドをご覧ください。
- 店舗向け:自社アプリでデジタルレシートを発行・Webhookで通知するガイド
- ウォレットアプリ向け:ユーザーのレシートをOAuthで取得するガイド
- API認証ガイド(OAuth 2.0 認可コードフロー)
User系スコープを使う場合の追加ステップ
個人ユーザーのレシート・支出・お気に入り店舗などのデータを扱う場合(user.* スコープ)は、上記の流れに加えて事前審査が必要です。
- 通常どおりアプリを登録し、
user.*スコープを指定する - 登録時点で
UserScopeStatus = pendingになります - レシートローラーのサポートにアプリのユースケース・対象ユーザー・データの取り扱い方針を連絡します
- 運営チームの審査で
approvedになったら、認可フローでuser.*スコープが使えるようになります
未審査の状態で user.* を指定して認可URLを呼び出すと app_not_approved エラーが返ります。
よくある質問
Q. 開発者として別アカウントを作る必要はありますか?
A. ありません。通常の店舗アカウントがそのまま開発者アカウントとして使えます。組織内で開発を担当するメンバーをスタッフとして招待し、必要なロールを付与してください。
Q. テスト・開発用と本番運用でアプリを分けたほうがいいですか?
A. 推奨します。アプリは複数登録できるので、開発用と本番用でクライアントIDを分けると、リダイレクトURIや権限を独立に管理できます。
Q. フリープランで試すことはできますか?
A. 開発者APIはスタータープラン以上が必要です。アプリ登録画面自体がフリープランでは表示されません。試したい場合はスターターの最小契約からお試しください。
Q. 既存の店舗アカウントから開発者ポータルへ進むメニューはどこにありますか?
A. 店舗管理画面のメニューに「デベロッパー」または「開発者ポータル」の項目が表示されます。スタータープラン以上で表示されます。
Q. 自社POS連携など、店舗データだけを扱う場合も審査は必要ですか?
A. 不要です。Store系スコープのみであれば、アプリ登録と同時に利用できます。審査が必要なのは user.* スコープ(コンシューマー個人データ)のみです。
関連ガイド
-
利用できるデータ領域レシートローラーの開発者ポータルから取得できるデータ領域を一覧で説明します。取引・商品・在庫・受注・顧客・クーポン・SNS・広告・個人ユーザーデータなど、各領域に含まれる内容と取得方法、必要なスコープをまとめています。
-
開発者ポータルでできることレシートローラーの開発者ポータルでできることを概観します。REST APIによるデータ取得・操作、Webhookによるリアルタイムイベント受信を組み合わせて、外部システムから店舗・ユーザーデータを連携できます。
-
アプリケーション登録とはレシートローラーのアプリケーション登録の概念を説明します。OAuthクライアントとしてアプリを登録することで、クライアントID・シークレット・リダイレクトURIが発行され、API・Webhook連携を始められます。