レガシーAPIキーの廃止

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

Workatoは、2023年1月11日にレガシーAPIキー認証からAPIクライアント認証に移行しました。 この移行中、機能を維持するために、レガシーAPIキーは"Migrated API client"という名前のAPIクライアントに自動的に移動されました。

2025年7月14日現在、レガシーAPIキーは完全に廃止されています。レガシーAPIキーを通じて認証されたAPIリクエストは拒否されます。 影響を受けるユーザーには2025年04月14日にメール通知が送信され、レガシーAPIキーをまだ使用しているユーザーには2025年07月に第2弾が送信されました。 2025年10月14日以降、レガシーAPIキー機能はすべてのユーザーに対して完全に削除されます。

アクションが必要です

直ちにAPIクライアント認証に移行する必要があります。 すべてのAPIリクエストでは、x-user-tokenヘッダーおよびx-user-emailヘッダーの代わりにAuthorization: Bearerヘッダーを使用する必要があります。

これは自分に影響しますか

現在、次の方法でレガシーAPIキー認証を使用している場合は影響を受けます:

  • APIリクエストのx-user-tokenヘッダーおよびx-user-emailヘッダー
  • クエリパラメーターのAPIキーおよびメールアドレス
  • ワークスペース内の"Migrated API client"

レガシーAPIキーの場所

レガシーAPIキーは、Admin権限を持つ"Migrated API client"としてワークスペース管理者>APIクライアントに移動されました。 クライアントトークンは元のAPIキーです。

Environmentが有効化されたワークスペースでは、各Environmentに対して個別のクライアントが自動的に作成されました: Migrated API client - {Environment name}

APIクライアント認証への移行

レガシーAPIキー認証からAPIクライアント認証に移行するには、次の手順を完了します:

1

APIクライアント設定ガイドに従って、新しいAPIクライアントを作成します。

2

新しいAPIトークンをAuthorization: Bearerヘッダーで使用するようにアプリケーションを更新します。

3

新しい認証方法で動作することを確認するために、連携をテストします。

4

レガシーAPIキーを使用する"Migrated API client"を削除します。

認証形式の変更

レガシー形式(廃止):

shell
curl -X GET https://www.workato.com/api/users/me \
     -H 'x-user-token: <legacy_api_key>' \
     -H 'x-user-email: <user_email>'

新しい形式(必須):

shell
curl -X GET https://www.workato.com/api/users/me \
     -H 'Authorization: Bearer <api_client_token>'

レガシーAPIクライアントの削除

"Migrated API client"を削除すると、レガシー認証を使用しているすべてのアプリケーションのアクセス権が即座に取り消されます。 移行を完了した後でのみ、このクライアントを削除してください。

Last updated: