ドキュメント

Webshop Admin API リファレンス

ウェブショップ、環境、テーマ、ブランドをプログラムで設定するために使用できる Webshop Admin API エンドポイントを探るします。
読み終わるまでの所要時間 2 分最終更新 3ヶ月前

推奨されるベストプラクティスは、管理者が Unity Dashboard で Webshop を設定することです。
Webshop Admin API は、Unity Dashboard がワークフローに合わない場合に使用します。例えば、以下のような場合に使用します。
  • 多数の環境にわたるテーマの更新。
  • プロジェクト設定の一部としてのスクリプト Webshop の作成。
  • Webshop設定をDeploymentパイプラインに統合します。
このページでは、APIリファレンスにリンクし、管理API呼び出しの認証と承認の仕組みについて説明します。

Authentication

Admin API はサービス アカウント認証情報を使用します。Unity Dashboardからサービス アカウント キーを生成し、
key_id:secret_key
ペアをbase64エンコードして、リクエストでBearerトークンとして送信します。
ステップ バイ ステップの手順については、サービス アカウント認証ガイドを参照してください。

Authorization

各管理 API エンドポイントには、特定のサービスアカウントロールが必要です。ロールのリストと操作ごとの要件については、Webshop アクセス権リファレンス を参照してください。

API リファレンス