APIトークン（使用非推奨）¶
注意
予測APIの/predApi/v1.0/api_token/エンドポイントは廃止されました。
UIではAPIキー管理を使用してください。 DataRobot APIでは、以下を使用してください。
- 新規のAPIトークンを作成する場合：
POST /api/v2/api_token/ - 既存のAPIトークンを取得する場合：
GET /api/v2/api_token/
DataRobot APIルートを使用してトークンを作成または取得する際にサポートが必要な場合は、DataRobotの担当者あるいはサポートにお問い合わせください。
DataRobotでは、APIトークンがユーザーのアカウントに自動的に割り当てられます。 以下の例は、廃止された方法を使用した場合を示します。 従来の方法を使用する場合は、以下の点に注意してください。
example.orm.datarobot.comを専用の予測インスタンスの名前で置き換えてください。 専用の予測インスタンスがあるかどうかがわからない場合、またはそのアドレスがわからない場合は、DataRobotの担当者またはDataRobotサポートにお問い合わせください。- 認証のために
datarobot-keyを提供する必要があるのはマネージドAIクラウドのユーザーだけです。
!!! info 「本機能の提供について」 クラウドユーザーの場合、認証のためにdatarobot-key（トークンではありません）が必要です。このキーは予測 > 予測APIタブで取得できますが、DataRobotの担当者に連絡して入手することもできます。
GETを介したトークンの取得¶
ユーザー名とパスワードで predApi/v1.0/api_token エンドポイントに対するGETリクエストを作成することができます。 この方法では、以前POSTリクエストで作成されたトークンと同じものが再発行されます。
オンプレミスの例:
curl -X GET
"https://example.orm.datarobot.com/predApi/v1.0/api_token" -u john@example.com
{"api_token": "wKx7N68uqTns-v8xd9WJKXf9w5e0duo-"}
マネージドAIクラウドの例:
curl -H "datarobot-key: xxxx" -X GET
"https://example.orm.datarobot.com/predApi/v1.0/api_token" -u john@example.com
{"api_token": "wKx7N68uqTns-v8xd9WJKXf9w5e0duo-"}
APIトークンの置き換え¶
APIトークンを変更(新規作成)する必要がある場合があります(トークンが漏洩した場合など)。 各アカウントには、予測APIとDataRobot APIの両方に対して使用される単一のトークンが割り当てられています。 このリクエストでは、以前のトークンが無効化され、そのトークンを使用しているアプリケーションは更新する必要があります。 APIトークンを変更するには、ユーザー名とパスワードで api/v2/api_token/ エンドポイントに対してPOSTリクエストを作成します。 例：
オンプレミスの例:
curl -X POST
"https://example.orm.datarobot.com/predApi/v1.0/api_token" -u john@example.com
{"api_token": "wKx7N68uqTns-v8xd9WJKXf9w5e0duo-"}
マネージドAIクラウドの例:
curl -H "Content-Type: application/json" -X POST
"https://example.orm.datarobot.com/api/v2/api_token/"
-d '{"username": "john@example.com", "password": "thisIsAPassword"}'
{"api_token": "wKx7N68uqTns-v8xd9WJKXf9w5e0duo-"}
2FA¶
アカウントで2要素認証を有効にした場合、HTTPリクエストで第2の要素を提供する必要があります。 predApi/v1.0を使用する場合、ヘッダーX-DataRobot-totpCodeを使用してTOTPコード（認証アプリで生成されたコード）を送信するか、X-DataRobot-recoveryCodeを使用してリカバリーコードを送信することができます。 api/v2の場合、JSONペイロードで対応する値をtotpCodeまたはrecoveryCodeとして送信する必要があります。
次の例ではTOTPコード000000を使用しています。 この値は、認証アプリで生成された値で置き換える必要があります。
オンプレミスの例:
curl -H "X-DataRobot-totpCode: 000000" -X GET
"https://example.orm.datarobot.com/predApi/v1.0/api_token" -u john@example.com
-H "X-DataRobot-totpCode: 000000"
{"api_token": "wKx7N68uqTns-v8xd9WJKXf9w5e0duo-"}
マネージドAIクラウドの例（取得）:
curl -H "datarobot-key: xxxx" -H "X-DataRobot-totpCode: 000000" -X GET
"https://example.orm.datarobot.com/predApi/v1.0/api_token" -u john@example.com
{"api_token": "wKx7N68uqTns-v8xd9WJKXf9w5e0duo-"}
マネージドAIクラウドの例（置換）:
curl -H "Content-Type: application/json" -X POST
"https://example.orm.datarobot.com/api/v2/api_token/"
-d '{"username": "john@example.com", "password": "thisIsAPassword", "totpCode": "000000"}
{"api_token": "wKx7N68uqTns-v8xd9WJKXf9w5e0duo-"}