Dela via


ApiKeyCredentials class

Autentiserar till en tjänst med hjälp av en API-nyckel.

Konstruktorer

ApiKeyCredentials(ApiKeyCredentialOptions)

Metoder

signRequest(WebResourceLike)

Signerar en begäran med värdena i parametern inHeader och inQuery.

Konstruktorinformation

ApiKeyCredentials(ApiKeyCredentialOptions)

new ApiKeyCredentials(options: ApiKeyCredentialOptions)

Parametrar

options
ApiKeyCredentialOptions

Anger vilka alternativ som ska anges för autentisering. Antingen sidhuvud eller fråga måste anges.

Metodinformation

signRequest(WebResourceLike)

Signerar en begäran med värdena i parametern inHeader och inQuery.

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

Parametrar

webResource
WebResourceLike

Den WebResource som ska signeras.

Returer

Promise<WebResourceLike>

Det signerade begärandeobjektet.