Freigeben über


ApiKeyCredentials class

Authentifiziert sich mit einem API-Schlüssel bei einem Dienst.

Konstruktoren

ApiKeyCredentials(ApiKeyCredentialOptions)

Methoden

signRequest(WebResourceLike)

Signiert eine Anforderung mit den InHeader- und inQuery-Parametern bereitgestellten Werten.

Details zum Konstruktor

ApiKeyCredentials(ApiKeyCredentialOptions)

new ApiKeyCredentials(options: ApiKeyCredentialOptions)

Parameter

options
ApiKeyCredentialOptions

Gibt die Optionen an, die für die Authentifizierung bereitgestellt werden sollen. Entweder Kopfzeile oder Abfrage muss bereitgestellt werden.

Details zur Methode

signRequest(WebResourceLike)

Signiert eine Anforderung mit den InHeader- und inQuery-Parametern bereitgestellten Werten.

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

Parameter

webResource
WebResourceLike

Die zu signierte WebResource.

Gibt zurück

Promise<WebResourceLike>

Das signierte Anforderungsobjekt.