Wix API キーを管理する

読了時間:9分
Wix API キーは、ユーザーまたはアプリケーションを認証し、サイトおよびアカウントのデータにアクセスするために生成できるコードです。
Wix API キーを使用して注文、商品、イベントなどのデータにアクセスし、独自のカスタム機能を構築してサードパーティ製アプリに接続しましょう。

Wix API キーを生成する

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

API キーを生成する方法:

  1. アカウント設定で「API キー」にアクセスします。
  2. +API キーを生成する」をクリックします。
  3. キーの詳細」下に新しい API キーの名前を入力します。
  4. API キーに割り当てるアクセス権を選択します。
    • アカウント内のすべてのサイトの ID を返す基本のアクセス権がデフォルトで選択されています。この選択を解除することはできません。
    • セキュリティ確保のため、必要なアクセス権のみを追加してください。キーのアクセス権に関する詳細はこちら
  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 キーをローテーションするスクリーンショット
  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 キーを編集することができます。API キーを編集できるユーザーを変更するには、サイトの役割・権限またはパートナーダッシュボードにアクセスしてください(Wix パートナーの場合)。

API キーを編集する方法:

  1. アカウント設定で「API キー」にアクセスします。
  2. 編集したい API キー横の「その他のアクション」アイコン  をクリックします。
  3. 編集」を選択します。
API キーを編集するスクリーンショット
  1. API キーの名前またはアクセス権を編集します。
  2. 保存して閉じる」をクリックします。
API キーの変更を保存するスクリーンショット
  1. コードを送信」をクリックして、アカウントにリンクされているメールアドレスに 6桁の認証コードを送信します。
  2. メールを開いて認証コードを確認します。
  3. アカウントを認証」ポップアップにコードを入力します。
  4. 認証して変更を保存する」をクリックします。
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 キーに関する詳しい情報:

お役に立ちましたか?

|