API と連携

適切な API ワークフローを選ぶ

推論 API はモデルの推論リクエストを扱います。一方、モデル学習 API では、見積もり、ジョブ、セッション、成果物を含む別の学習ワークフローを説明しています。推論エンドポイントで学習を開始できる、または学習操作を推論仕様から利用できるとは限りません。利用する製品のドキュメントを読み、必要なモデルや学習機能が掲載されていることを確認してください。使い慣れたサードパーティ SDK からメソッド名を推測せず、公開されたリクエストとレスポンスの形式に従ってください。

1. アプリケーションに必要なのが推論かモデル学習かを特定する。
2. 対応する製品ドキュメントと API リファレンスを開く。
3. 必要な機能とモデルがドキュメントに記載されていることを確認する。

API キーを作成して保護する

認証済みの API キーページからカスタマー API キーを作成し、画面でスコープを選択できる場合は、連携に必要なものだけを選んでください。秘密情報は一度しか表示されないため、承認済みのシークレットマネージャーに直接保存し、ソース管理へのコミット、ログへの貼り付け、ブラウザーコードへの埋め込みは避けてください。可能であれば、アプリケーションと環境ごとに認証情報を識別できる名前を付けます。開発環境と本番環境で認証情報を分ければ、他の連携に影響を与えずに一方を失効できます。

1. 認証済みのカスタマーワークスペースから API キーを開く。
2. 必要最小限のスコープを付けたキーを作成する。
3. 秘密情報を安全に保存し、ソースコードやログに含めない。

公開された仕様に沿って実装する

認証、エンドポイント、リクエストフィールド、レスポンス処理、エラーについて、該当する API ガイドに従ってください。サービスの認証情報は公開クライアントコードではなく、信頼できるサーバー上で管理します。送信前に入力を検証し、成功以外のレスポンスを明示的に処理してください。Authorization ヘッダーや機密性の高いプロンプト内容をログに記録しないでください。機械可読な公開仕様が必要な場合は OpenAPI リファレンスを使います。現行ドキュメントに明記されていないストリーミング、メディア、プロバイダー固有の操作を推測しないでください。

1. 選択した API に記載された操作とフィールドだけを実装する。
2. 認証情報はサーバー側で管理し、診断ログから除外する。
3. 記載されたエラーを処理し、返されるリクエスト ID を保持する。

利用状況を監視して認証情報を管理する

連携後、利用状況ページでアカウントに関連する活動を確認し、アプリケーション側の記録と照合してください。トラフィックを増やしたり認証情報を追加したりする前に、予期しない変化を調査します。キーが漏えいした可能性がある場合はローテーションし、アプリケーションのシークレットストアを更新して、古いキーを削除する前に連携が動作することを確認してください。不要になったキーは失効させます。利用状況の表示は運用確認に役立ちますが、将来の料金や容量を保証するものではありません。

1. プラットフォームの利用状況をアプリケーションのリクエスト記録と照合する。
2. 漏えいした認証情報をローテーションし、置き換え後の動作を確認する。
3. 使っていないキーを失効させ、定期的にアクセス権を確認する。

よくある質問

関連ページ

• 推論 API ドキュメント
• API キー
• 利用状況
• OpenAPI リファレンス