ApiKeyCredentials class

API キーを使用してサービスに対して認証します。

コンストラクター

ApiKeyCredentials(ApiKeyCredentialOptions)

メソッド

signRequest(WebResourceLike)

inHeader パラメーターと inQuery パラメーターで指定された値を使用して要求に署名します。

コンストラクターの詳細

ApiKeyCredentials(ApiKeyCredentialOptions)

new ApiKeyCredentials(options: ApiKeyCredentialOptions)

パラメーター

options
ApiKeyCredentialOptions

認証に指定するオプションを指定します。ヘッダーまたはクエリを指定する必要があります。

メソッドの詳細

signRequest(WebResourceLike)

inHeader パラメーターと inQuery パラメーターで指定された値を使用して要求に署名します。

function signRequest(webResource: WebResourceLike): Promise<WebResourceLike>

パラメーター

webResource
WebResourceLike

署名する WebResource。

戻り値

Promise<WebResourceLike>

署名された要求オブジェクト。