Wix ヘルプセンター
    ホーム
  1. Wix Studio・パートナー・エンタープライズ
  2. Wix エンタープライズ
  3. エンタープライズダッシュボード
    4. エンタープライズソリューション：Wix API キーを使用する

エンタープライズソリューション：Wix API キーを使用する

読了時間：10分
Wix API キーは、ユーザーまたはアプリケーションを認証し、サイトやアカウントデータへのアクセスを許可するために生成できるコードです。
Wix API キーを使用して、注文、商品、イベントなどのサイトデータに安全にアクセスしましょう。このデータを使用して、Wix ストアや Wix ブッキングなどの Wix ビジネスソリューションに接続するための独自のカスタム機能を構築したり、サードパーティのサービスに接続したりすることができます。また、新しいアカウントの作成など、アカウントレベルのデータへのアクセスや更新も可能です。
API キーは、エンタープライズダッシュボードの「設定」セクションで管理できます。新しいキーの生成、既存のキーのローテーションまたは複製、詳細と権限の編集、不要になったキーの削除などを行うことができます。
この記事では、次の項目について説明します：

Wix API キーについて

アプリケーションプログラミングインターフェース（API）は、コンピューター間のリクエストと応答のやり取りに使用される通信プロトコルです。たとえば、メールアドレスとパスワードを使用して Wix アカウントにログインすると、API が資格情報を使用して Wix へのログイン権限を認証します。

API キーは、ユーザーまたはアプリケーションが自身を認証するために API に送信できるコード（文字列）です。API キーが有効な場合、API はそのデータへのアクセスを許可します。アクセスできる特定のデータは、API キーの権限セットに基づいて決まります。
API キーの権限セットのスクリーンショット

Wix API キーを使用して Wix API を呼び出す

エンタープライズダッシュボードで生成した API キーを使用すると、Wix API を使用してアカウントおよびサイトのデータにアクセス・管理し、カスタム機能を構築することができます。
たとえば、ストアから商品リストを取得する、ストアに新商品を追加する、またはその新商品について SNS に自動的に投稿するといった操作を実行できます。

Wix API キーを生成する

エンタープライズダッシュボードの「設定」セクションで、サイトのデータにアクセスするための API キーを生成することができます。
重要：
  • デフォルトでは、生成した各 API キーによってアカウント内のすべてのサイトにアクセスすることができます。これは、API キーがアカウントレベルで生成されるためです。
  • セキュリティを強化するため、生成した各 API キートークンは作成時に一度だけ表示されます。
  • 「API キーが生成されました」ポップアップを閉じた後、API キーのトークンを再度表示することはできません。今後アクセスできるよう、トークンは安全な場所に保管してください。

API キーを生成する方法：

  1. エンタープライズダッシュボードで「API キー」にアクセスします。
  2. 右上の「＋API キーを生成する」をクリックします。
  3. 「キーの詳細」下に新しい API キーの名前を入力します。
  4. API キーに割り当てるアクセス権を選択します。
    • アカウント内のすべてのサイトの ID を返す基本のアクセス権がデフォルトで選択されています。この選択を解除することはできません。
    • セキュリティ確保のため、必要なアクセス権のみを追加してください。API セキュリティに関する詳細はこちら
  5. 「キーを生成する」をクリックします。
  6. 「コードを送信」をクリックして、アカウントにリンクされているメールアドレスに 6桁の認証コードを送信します。
  7. メールを開いて認証コードを取得します。
  8. 「アカウントを認証」ポップアップにコードを入力します。
  9. 「認証してキーを生成する」をクリックします。
API キーを認証しているスクリーンショット
  1. 「トークンをコピーして閉じる」をクリックします。
  2. トークンを安全な場所に保管します。
ヒント：
同じアクセス権を持つ別の API キーが必要な場合は、API キーをローテーションまたは API キーを複製することができます。

Wix API キーをローテーションする

API キーをローテーションして、同じ名前、説明、アクセス権を維持したまま、新しいトークンを作成することができます。API キーをローテーションすると、以前アクセス権を持っていたユーザーはそのキーを使用できなくなるため、新しいトークンを共有する必要があります。
重要：
  • API キーをローテーションすると、それを使用していたユーザーやアプリケーションは即座にデータにアクセスできなくなります。
  • API キーを更新した後は、以前のトークンを復元することはできません。
ヒント：
  • ほとんどの場合は、API キーを複製し、新しいトークンを API コールに追加して、その新しいトークンを必要とするチームメンバーに共有することが推奨されます。古い API キーは削除してください。
  • これにより、キーを使用する API のサービスが中断されることはありません。
  • API キーのローテーションは、キーが侵害されたと思われる場合にのみ行うことをおすすめします。

API キーをローテーションする方法：

  1. エンタープライズダッシュボードで「API キー」にアクセスします。
  2. 右上の「＋API キーを生成する」をクリックします。
  3. ローテーションしたい API キー横の「その他のアクション」アイコン  をクリックします。
  4. 「ローテーション」を選択します。
API キーをローテーションしているスクリーンショット
  1. ポップアップで「ローテーションする」をクリックします。
  2. 「コードを送信」をクリックして、アカウントにリンクされているメールアドレスに 6桁の認証コードを送信します。
  3. メールを開いて認証コードを取得します。
  4. 「アカウントを認証」ポップアップにコードを入力します。
  5. 「認証してキーをローテーションする」をクリックします。
ローテーションされた API キーを認証しているスクリーンショット
  1. 「トークンをコピーして閉じる」をクリックします。
  2. トークンを安全な場所に保管します。

Wix API キーを複製する

同じアクセス権を持つ別の API キーが必要な場合は、既存の API キーのいずれかを複製することができます。キーを複製した後、さらにカスタマイズする必要がある場合はその説明とアクセス権を編集することもできます。
重要：
  • デフォルトでは、生成した各 API キーによってアカウント内のすべてのサイトにアクセスすることができます。これは、API キーがアカウントレベルで生成されるためです。
  • セキュリティを強化するため、生成した各 API キートークンは作成時に一度だけ表示されます。
  • 「API キーが生成されました」ポップアップを閉じた後、API キーのトークンを再度表示することはできません。今後アクセスできるよう、トークンは安全な場所に保管してください。

API キーを複製する方法：

  1. エンタープライズダッシュボードで「API キー」にアクセスします。
  2. 複製したい API キー横の「その他のアクション」アイコン  をクリックします。
  3. 「複製」を選択します。
API キーを複製しているスクリーンショット
  1. 「キーの詳細」下に新しい API キーの新しい名前を入力します。
  2. （オプション）API キーに割り当てられているアクセス権を編集します。
    • アカウント内のすべてのサイトの ID を返す基本のアクセス権がデフォルトで選択されています。この選択を解除することはできません。
    • セキュリティ確保のため、必要なアクセス権のみを追加してください。詳細はこちら
  3. 「キーを生成する」をクリックします。
  4. 「コードを送信」をクリックして、アカウントにリンクされているメールアドレスに 6桁の認証コードを送信します。
  5. メールを開いて認証コードを取得します。
  6. 「アカウントを認証」ポップアップにコードを入力します。
  7. 「認証してキーを生成する」をクリックします。
複製された API キーを確認しているスクリーンショット
  1. 「トークンをコピーして閉じる」をクリックします。
  2. キーは安全な場所に保管してください。

Wix API キーを編集する

API キーを作成した後は、「API キーを編集」ページで名前と権限を更新できます。

API キーを編集する方法：

  1. エンタープライズダッシュボードで「API キー」にアクセスします。
  2. 編集したい API キー横の「その他のアクション」アイコン  をクリックします。
  3. 「編集」を選択します。
API キーを編集しているスクリーンショット
  1. API キーの名前またはアクセス権を編集します。
  2. 「保存して閉じる」をクリックします。
API キーの変更を保存しているスクリーンショット
  1. 「編集内容を保存する」をクリックして確定します。
  2. 「コードを送信」をクリックして、アカウントにリンクされているメールアドレスに 6桁の認証コードを送信します。
  3. メールを開いて認証コードを取得します。
  4. 「アカウントを認証」ポップアップにコードを入力します。
  5. 「認証して変更を保存する」をクリックします。
API キーの変更を確認するスクリーンショット

Wix API キーを削除する

エンタープライズダッシュボードの「設定」セクションで、不要になった API キーを削除することができます。
重要：
  • API キーのアクセス権を持つユーザーまたはアプリケーションは、キーを削除するとデータにアクセスできなくなります。
  • 削除した API キーを復元することはできません。

API キーを削除する方法：

  1. エンタープライズダッシュボードで「API キー」にアクセスします。
  2. 削除したい API キー横の「その他のアクション」アイコン  をクリックします。
  3. 「削除」を選択します。
API キーを削除しているスクリーンショット
  1. ポップアップで「削除する」をクリックします。
  2. 「コードを送信」をクリックして、アカウントにリンクされているメールアドレスに 6桁の認証コードを送信します。
  3. メールを開いて認証コードを取得します。
  4. 「アカウントを認証」ポップアップにコードを入力します。
  5. 「認証してキーを削除する」をクリックします。
API キーの削除を確認するスクリーンショット

Wix API キーのアクセス権を選択する

API キーに割り当てる権限によって、そのキーを使用して API 呼び出しがアクセスできるデータの種類が制御されます。
たとえば、Wix ストアの権限を選択して、商品、注文、通貨を含むサイトのストアデータへのアクセスのみを許可することができます。
重要：
ほとんどの権限は、サイトデータへの読み取りおよび書き込みアクセス権を自動的に付与します。サイトデータへの必要以上のアクセスを許可しないように、API キーには必要な権限のみを割り当てることが重要です。権限と API キーのセキュリティに関する詳細はこちら
「API キー」ページで API キーの横にある「アクセス権を表示」をクリックすると、API キーの権限を確認できます。
API キーの権限セットを表示しているスクリーンショット
また、アクセス権を追加または削除する必要がある場合は、いつでも API キーのアクセス権を編集することができます。

キーのアクセス権を編集する方法：

  1. エンタープライズダッシュボードで「API キー」にアクセスします。
  2. 編集したい API キー横の「その他のアクション」アイコン  をクリックします。
  3. 「編集」を選択します。
  4. 「アクセス権」下で API キーに割り当てる新しいアクセス権を選択します。
API キーの権限セットのスクリーンショット
  1. 「保存して閉じる」をクリックします。
  2. ポップアップで「編集内容を保存する」をクリックします。
  3. 「コードを送信」をクリックして、アカウントにリンクされているメールアドレスに 6桁の認証コードを送信します。
  4. メールを開いて認証コードを取得します。
  5. 「アカウントを認証」ポップアップにコードを入力します。
  6. 「認証して変更を保存する」をクリックします。
API キーの権限セットへの変更を確認するスクリーンショット

アカウント ID を取得する

サイトレベルの API を使用するには、HTTP リクエストのヘッダーに Wix アカウント ID を含める必要があります。アカウント ID は、エンタープライズダッシュボードの「API キー」ページで取得できます。

アカウント ID を取得する方法：

  1. エンタープライズダッシュボードで「API キー」にアクセスします。
  2. 「アカウント ID」下の「ID をコピー」をクリックします。
「API キー」ページでアカウント ID をコピーしているスクリーンショット
Wix API キーに関する詳しい情報：

お役に立ちましたか？

|
この記事では下記を説明します：
  • Wix API キーについて
  • Wix API キーを使用して Wix API を呼び出す
  • Wix API キーを生成する
  • Wix API キーをローテーションする
  • Wix API キーを複製する
  • Wix API キーを編集する
  • Wix API キーを削除する
  • Wix API キーのアクセス権を選択する
  • アカウント ID を取得する