エンドポイント一覧
以下の表は、backend-public-api/app.js に登録された公開ルートに対応しています。パスには、外部連携で使用する公開プロキシのプレフィックスが含まれています。
| メソッド | エンドポイント | 説明 | アクセス |
|---|---|---|---|
GET | /public-api/healthz | サービスのヘルスチェック。 | 公開 |
GET | /public-api/v1/auth/check | 認証情報を検証し、ストアフロント、スコープ、プランの機能を返します。 | 任意の認証済み認証情報 |
GET | /public-api/v1/customer-orders | ページ分割と絞り込みに対応した顧客注文の一覧を返します。 | orders:read |
GET | /public-api/v1/customer-orders/:id | 設定済みの商品項目を含む単一の顧客注文を返します。 | orders:read |
POST | /public-api/v1/customer-orders/batch | ID を指定して最大 100 件の注文を取得します。 | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | 注文ステータスを更新します。 | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | 選択した注文明細の数量を更新します。 | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | 注文内のすべての項目に同じ数量を設定します。 | orders:write |
DELETE | /public-api/v1/customer-orders/:id | ストアフロントの所有者に属する顧客注文を削除します。 | orders:write |
GET | /public-api/v1/products | 埋め込みの可否とメディア URL を含む、ストアフロントの商品／デザインを返します。 | products:read |
GET | /public-api/v1/products/:id | ストアフロントの商品／デザインを一件返します。 | products:read |
POST | /public-api/v1/embed/session | モデルジェネレーターを含む埋め込みツール向けに、短時間有効なJWTを発行します。 | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | 埋め込み JWT からランタイムのコンテキストを解決します。 | Bearer 埋め込みトークン |
GET | /public-api/v1/assets | 指定した種類のアセットカタログ項目を一覧表示します。 | 任意の認証済み認証情報 |
GET | /public-api/v1/assets/:type/:assetId | ダウンロード可能なファイルの役割を含むアセットマニフェストを返します。 | 任意の認証済み認証情報 |
GET | /public-api/v1/assets/:type/:assetId/files/:role | 役割を指定してアセットファイルをダウンロードします。 | 任意の認証済み認証情報 |
GET | /public-api/v1/design-imports | Alter でホストされているインポート可能なデザインを一覧表示します。 | 認証済み認証情報、Business プランが必要 |
GET | /public-api/v1/design-imports/:id | デザインのインポートペイロードとファイルの記述情報を返します。 | 認証済み認証情報、Business プランが必要 |
GET | /public-api/v1/design-imports/:id/files/:fileId | デザインのインポート記述情報からファイルをダウンロードします。 | 認証済み認証情報、Business プランが必要 |
GET | /public-api/v1/file/public/products/:productId/:size | 商品の公開プレビューを返します。サイズには small.png、medium.png、big.png のいずれかを指定してください。 | 公開 |
GET | /public-api/v1/file/protected/:key | ストレージキーを指定して保護されたファイルを取得します。 | 署名付き URL または files:read |
GET | /public-api/v1/fonts | 利用可能なすべてのフォントを返します。 | 公開 |
GET | /public-api/v1/currencies | すべての通貨を返します。 | 公開 |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | WordPress の商品マッピングからランタイムバインディングを作成または更新します。 | 任意の認証済み認証情報 |
PATCH | /public-api/v1/runtime-bindings/:id | ランタイムバインディングを部分更新します。 | 任意の認証済み認証情報 |
POST | /public-api/v1/runtime-bindings/:id/activate | ランタイムバインディングを有効にします。 | 任意の認証済み認証情報 |
POST | /public-api/v1/runtime-bindings/:id/deactivate | ランタイムバインディングを無効にします。 | 任意の認証済み認証情報 |
POST | /public-api/v1/wp-connect/exchange | WordPress の自動接続用引き継ぎコードを API 認証情報と交換します。 | 使い捨ての引き継ぎコード |
GET | /public-api/v1/model-generator/catalog | 表示可能なジェネレーター製品、構成、テンプレートのリビジョンを一覧表示します。 | embed:session:create |
GET | /public-api/v1/model-generator/models | インポート対象のジェネレーターソースを特定のリビジョンに固定した記述子付きでモデルを一覧表示します。 | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Designerで使用するジェネレーターモデルのカタログを返します。 | embed:session:create |
GET | /public-api/v1/model-generator/projects | 所有者のジェネレータープロジェクトと、全ユーザーに公開されたプロジェクトを一覧表示します。 | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | プロジェクトの最新または指定リビジョン、テンプレート、ファイルマニフェストを返します。 | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | プロジェクトの最新または指定リビジョン、テンプレート、ファイルマニフェストを返します。 | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | プロジェクトへのアクセスを確認してから成果物をダウンロードします。 | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | 選択した構成リビジョンに対応する、アクセス可能なテンプレート文書を返します。 | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | 依存ファイルを含むテンプレートのインポートパッケージを返します。 | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | 両方のマネキンと、それぞれのアセット記述子を返します。 | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | インポート可能なファイル付きで、テクスチャまたは背景ライブラリのアセットを一覧表示します。 | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | 単一のテクスチャまたは背景アセットを、そのインポート可能なファイルとともに返します。 | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | 許可されたジェネレーターの依存ファイルをダウンロードします。 | embed:session:create |