アプリを新規作成する
app-registration
oauth
client
developer-portal
このガイドについて
開発者ポータルで新しいアプリを登録する具体的な操作手順を説明します。アプリ登録の概念や全体像はアプリケーション登録とはを先にご確認ください。
開発者ポータルで新しいアプリを登録する具体的な操作手順を説明します。アプリ登録の概念や全体像はアプリケーション登録とはを先にご確認ください。
アプリを新規作成する
レシートローラーの店舗管理画面から開発者ポータルを開き、新しいアプリ(OAuthクライアント)を登録します。所要時間は3〜5分程度です。
前提
- レシートローラーの店舗アカウントを持っていること
- 組織のプランがスタータープラン以上であること
- ログイン中のメンバーがオーナーまたは開発者ロールを持っていること
満たしていない場合は利用開始までの流れを先にご確認ください。
ステップ1:開発者ポータルを開く
- 店舗管理画面にログインします
- 左メニューから「デベロッパー」または「開発者ポータル」を選択します
- アプリ一覧画面が表示されます
メニューに表示されない場合は、プランがフリーのままになっていないかご確認ください(利用開始までの流れ)。
ステップ2:「アプリを登録」をクリック
アプリ一覧画面の右上にある「アプリを登録」または「新規アプリ作成」ボタンをクリックすると、登録フォームが開きます。
ステップ3:必要項目を入力
| 項目 | 必須 | 説明 |
|---|---|---|
| アプリ名 | 必須 | OAuth認可画面でユーザーに表示される名称。例:「自社EC連携」「家計簿アプリXYZ」 |
| 説明 | 推奨 | アプリの目的を1〜2文で記載。認可画面で「このアプリは○○のために△△を要求しています」のように表示 |
| リダイレクトURI | 必須 | OAuth認可後にコードを返すURL。複数登録可(開発・本番で分ける) |
| 必要なスコープ | 必須 | このアプリが要求するOAuthスコープのセット。最小限を選択 |
| 利用目的・接続先カテゴリ | 必須 | POS / EC / 分析 / マーケ / 自社モバイルアプリ など、用途を申告 |
| ホームページURL | 任意 | アプリ提供者のWebサイト。認可画面で「詳細はこちら」リンクとして表示 |
| サポート連絡先 | 任意 | ユーザーが問い合わせるためのメールアドレス。認可画面に表示 |
| プライバシーポリシーURL | User系スコープを含む場合は必須 | 個人ユーザーデータを扱うアプリは必ずプライバシーポリシーを公開する必要があります |
アプリ名のコツ
- 具体的に — 「APIテスト」より「自社EC連携 (本番)」のほうが管理しやすい
- 環境を含める — 開発・本番で別アプリを登録する場合は「(dev)」「(prod)」を付けるとミスを防げる
- 2〜30文字 — 認可画面のレイアウトが崩れない長さに
リダイレクトURIの入力
- HTTPS必須(本番) —
http://はlocalhost以外で受け付けません - 完全一致 — 認可URLで指定する
redirect_uriは、ここで登録したURIと完全一致する必要があります(末尾のスラッシュ・大文字小文字を含めて) - 複数登録可 — 例:
http://localhost:3000/callback(開発)とhttps://your-app.example.com/callback(本番)を両方登録 - クエリ・フラグメント不可 —
?foo=barや#hashは含められません
詳しくは次節のリダイレクトURLの設定で解説します。
スコープの選択
必要なスコープを最小限で選択してください。「念のため」追加するのはおすすめしません。スコープを追加・削除した場合は、既存のアクセストークンを取り直す必要があります。
- Store系のみ(
store.*/crm.*/sns.*/analytics.*) → 即時利用可 - User系を含む(
user.*) → 審査が必要(OAuthスコープ一覧参照) - Store系とUser系は混ぜられません — 同一アプリで両方は要求できません。両方扱う場合はアプリを2つ登録
ステップ4:「作成」ボタンをクリック
すべての必須項目を入力したら「作成」または「登録」をクリックします。バリデーションエラーがあれば該当フィールドに赤字で表示されます。
ステップ5:クレデンシャルを保管
作成成功後、クライアントIDとクライアントシークレットが表示されます。
クライアントシークレットはこの画面でしか表示されません
画面を閉じるとシークレットを再表示することはできません。必ず以下の手順で安全に保管してください。
画面を閉じるとシークレットを再表示することはできません。必ず以下の手順で安全に保管してください。
- パスワードマネージャー(1Password・Bitwarden など)に保存
- 本番運用ではサーバーの環境変数・シークレットマネージャー(AWS Secrets Manager・Azure Key Vault など)で管理
- Gitリポジトリには絶対に含めない(
.envファイルは.gitignoreに追加) - 紛失した場合はシークレット再生成が必要で、既存のシークレットは即座に無効になります
クライアントIDは公開しても問題ありません。アプリの設定画面でいつでも確認できます。
作成後にできること
登録したアプリは、開発者ポータルのアプリ一覧から再度開いて以下の操作ができます。
- アプリ名・説明・URLの編集 — 名前変更や説明の更新は随時可能
- リダイレクトURIの追加・削除 — 環境追加に応じて柔軟に管理
- スコープの変更 — 既存トークンは再取得が必要になります
- シークレットの再生成 — 漏洩時・定期ローテーション時に。古いシークレットは即座に無効化
- アプリの無効化・削除 — 利用終了時。既存のアクセストークンも無効になります
- 監査ログの確認 — このアプリ経由の主要なAPIアクセス・トークン発行履歴
よくあるエラー
| エラー | 原因 | 対処 |
|---|---|---|
| 「アプリ登録画面が表示されない」 | プランがフリー / ロール不足 | スターター以上にアップグレード、開発者ロールを付与 |
| 「リダイレクトURIの形式が不正」 | HTTPS以外(localhost除く)、クエリ・フラグメント含む、絶対URLでない | HTTPSの完全な絶対URLを入力(例: https://example.com/callback) |
| 「Store系とUser系を同時指定できません」 | 1つのアプリに store.* と user.* を混ぜている |
用途を分けて2つのアプリとして登録 |
| 「アプリ名はすでに使用されています」 | 同一組織内で同じ名前のアプリが存在 | 環境名を付ける等で一意な名前に変更 |
| 「プライバシーポリシーURLが未入力」 | User系スコープを含むのに必須項目が未入力 | 公開済みのプライバシーポリシーURLを入力 |
次のステップ
アプリ登録が完了したら、続けて以下を実装してください。
- リダイレクトURIの整理 — 開発・本番の使い分け方は本章のリダイレクトURL設定
- OAuth認可フロー — クライアントID・シークレットを使った認可コードフローの実装はAPI認証ガイド
- ユースケース別ガイド — 店舗向けWebhookガイド / ウォレットアプリ向けガイド
関連ガイド
公開日: 2026-04-27
更新日: 2026-04-27
カテゴリ
タグ
API (8)
Webhook (8)
api (6)
oauth (5)
トラブル (5)
OAuth (4)
getting-started (4)
アプリ登録 (4)
app-registration (3)
webhook (3)