saleor-app について
saleor-appは、Saleorを拡張するアプリの開発ガイドで、API、Webhook、決済、Dashboard UIを扱う開発者向けです。フレームワークに依存しないルールを優先度別に整理し、Next.jsの例も示します。
主な機能
- 01アプリマニフェストと登録規則
- 02同期・非同期Webhook処理
- 03決済アプリとTransaction APIの指針
- 04GraphQL認証とデータ設定
- 05Dashboard iframe UIの規則
- 06権限スコープとアクセス制御
活用シーン
- 01アプリマニフェストの定義とWebhook登録
- 02Saleor決済アプリの実装
- 03Webhookや認証エラーの調査
- 04Dashboard iframe内のアプリUI構築
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ saleor/ agent-skills --skill saleor-appインストール後、Claude Code で/saleor-appを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdreferences/apl-implementations.mdapp-manifest-schema.mdrules/dashboard-appbridge.mddata-graphql.mddata-settings.mddev-debug.mdpayment-app.mdpermissions-access-scopes.mdprotocol-auth.mdprotocol-manifest.mdwebhook-async.mdwebhook-external.mdwebhook-sync.md詳細
Saleor アプリ
ウェブフックと GraphQL API を介して Saleor を拡張するアプリの構築ガイドです。
フレームワークに依存しないプロトコルのドキュメントで、@saleor/app-sdk を使用した Next.js の例を掲載しています。
適用する場面
- アプリマニフェストを定義する、またはウェブフックを登録する
- Saleor からの非同期/同期ウェブフックイベントを処理する
- Transaction API とプロバイダーのウェブフックを使用して決済アプリを構築する
- リクエストを認証する(登録ハンドシェイク、JWT、署名検証)
- Saleor のメタデータにアプリの設定を保存する
- iframe 内にダッシュボード UI を構築する
- アプリトークンを使用して GraphQL 呼び出しを行う
- ウェブフックの失敗、認証エラー、権限の問題をデバッグする
- 誰がアプリを表示でき、何を表示するかを決定する(ユーザーのスコープとアプリのスコープ)
優先度別のルールカテゴリ
| 優先度 | カテゴリ | 影響 | プレフィックス |
|---|---|---|---|
| 1 | プロトコル | 重大 | protocol- |
| 2 | 権限 | 重大 | permissions- |
| 3 | 決済アプリ | 重大 | payment- |
| 4 | ウェブフック | 高 | webhook- |
| 5 | データと設定 | 高 | data- |
| 6 | ダッシュボード UI | 中 | dashboard- |
| 7 | 開発 | 中 | dev- |
クイックリファレンス
1. プロトコル(重大)
protocol-manifest— アプリマニフェスト、必須エンドポイント、権限、拡張機能protocol-auth— 登録ハンドシェイク、APL、トークンのスコープ、JWT/署名の検証
2. 権限(重大)
permissions-access-scopes— 機能ごとの権限を定義し、すべての API ルートでユーザー JWT を検証する。ベースラインとルートごとのメタデータを設定し、UI をサーバー側の動作に合わせる
3. 決済アプリ(重大)
payment-app— 金融上の真実、安定した参照情報、不明な結果、返金、照合
4. ウェブフック(高)
webhook-async— 非同期イベント処理、ペイロードの型付け、再試行ポリシー、署名検証webhook-sync— 同期イベント処理、レスポンススキーマ、パフォーマンス制約webhook-external— 外部サービスからのウェブフック受信、マルチテナントルーティング
5. データと設定(高)
data-graphql— アプリからの GraphQL:クライアント設定、認証ヘッダー、コード生成、アプリトークンとユーザートークンdata-settings— MetadataManager、EncryptedMetadataManager、ドメインスコープの永続化
6. ダッシュボード UI(中)
dashboard-appbridge— AppBridge iframe プロトコル、アクション、イベント、テーマ/ロケールの同期
7. 開発(中)
dev-debug— よくあるエラー、ウェブフックのドライラン、トンネル設定、デバッグチェックリスト
コメント
Markdown 対応