API キーは、Cloud de Confiance by S3NS API を呼び出すときに使用できる暗号化された単純な文字列です。API キーの一般的な用途は、次の形式でクエリ パラメータとして REST API 呼び出しにキーを渡すことです。
http://example-library.s3nsapis.fr/v1/publishers/mypublisher/books?key=API_KEY
API Keys は、プロジェクトの API キーを作成して管理するためのプログラマティック インターフェースを提供します。これにより、 Cloud de Confiance コンソールで実行できる API キー関連のタスクよりも、API キーをより詳細に制御できます。
Cloud de Confiance API に対する認証の詳細と、一般的なシナリオに最適な認証を決定する方法については、認証の概要をご覧ください。
API キーを保護する
アプリケーションで API キーを使用する場合は、保存時と転送時の両方でキーの安全確保に努めてください。 認証情報が公開されると、アカウントが侵害される可能性があります。 API キーの安全性を保つには、以下のベスト プラクティスに従ってください。
API キーをコードに直接埋め込まないでください。コードに埋め込まれた API キーは、誤って公開されてしまう可能性があります。たとえば、共有するコードからキーを削除し忘れた場合などです。API キーはアプリケーションに埋め込む代わりに、アプリケーションのソースツリー外部にある環境変数やファイル内に保存します。
API キーに制限を追加します。制限を追加することで、API キーが不正使用された場合の影響を軽減できます。
不要な API キーを削除して、攻撃を受けるリスクを最小限に抑えます。
API キーを定期的にローテーションします。API キーをローテーションするには、
CreateKeyメソッドを呼び出します。置換キーを作成したら、新たに生成したキーを使用するようにアプリケーションを更新し、古いキーを削除します。公開する前に、コードを確認します。コードを公開する前に、コードに API キーやその他のプライベート情報が含まれていないことを確認してください。