ApiKeyCredentials class
Authentifiziert sich bei einem Dienst mithilfe eines API-Schlüssels.
Konstruktoren
Api |
Methoden
sign |
Signiert eine Anforderung mit den im Parameter inHeader und inQuery angegebenen 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. Es muss entweder ein Header oder eine Abfrage bereitgestellt werden.
Details zur Methode
signRequest(WebResourceLike)
Signiert eine Anforderung mit den im Parameter inHeader und inQuery angegebenen Werten.
function signRequest(webResource: WebResourceLike): Promise<WebResourceLike>
Parameter
- webResource
- WebResourceLike
Die zu signierte WebResource.
Gibt zurück
Promise<WebResourceLike>
Das signierte Anforderungsobjekt.