Freigeben über


ApiKeyCredentials class

Authentifiziert sich bei einem Dienst mithilfe eines API-Schlüssels.

Konstruktoren

ApiKeyCredentials(ApiKeyCredentialOptions)

Methoden

signRequest(WebResourceLike)

Signiert eine Anforderung mit den Werten, die in den Parametern inHeader und inQuery angegeben sind.

Details zum Konstruktor

ApiKeyCredentials(ApiKeyCredentialOptions)

new ApiKeyCredentials(options: ApiKeyCredentialOptions)

Parameter

options
ApiKeyCredentialOptions

Gibt die Optionen an, die für die Authentifizierung bereitgestellt werden sollen. Es muss entweder ein Header oder eine Abfrage bereitgestellt werden.

Details zur Methode

signRequest(WebResourceLike)

Signiert eine Anforderung mit den Werten, die in den Parametern inHeader und inQuery angegeben sind.

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

Parameter

webResource
WebResourceLike

Die zu signierte WebResourceLike.The WebResourceLike to be signed.

Gibt zurück

Promise<WebResourceLike>

Das signierte Anforderungsobjekt.