Class AhoiBankingTokenService

Hierarchy

AbstractAhoiAuthenticationService
- AhoiBankingTokenService

Index

Constructors

constructor

Properties

Methods

authenticate

Constructors

constructor

new AhoiBankingTokenService(config: AhoiConfig, ahoiClientTokenService: AhoiClientTokenService, baseUrl: string): AhoiBankingTokenService

Overrides AbstractAhoiAuthenticationService.constructor
- Defined in ahoi/auth/bankingtokenauth.ts:16
Parameters
- config: AhoiConfig
- ahoiClientTokenService: AhoiClientTokenService
- baseUrl: string
Returns AhoiBankingTokenService

Properties

Static AUTH_BANKINGTOKEN_HEADER

AUTH_BANKINGTOKEN_HEADER: "X-Authorization-Ahoi" = "X-Authorization-Ahoi"

Static AUTH_CREDENTIALS_PARAMETER

AUTH_CREDENTIALS_PARAMETER: "grant_type=client_credentials" = "grant_type=client_credentials"

Static AUTH_URI

AUTH_URI: string = "/auth/v1/oauth/token"

Methods

authenticate

authenticate(installationId: string): Promise<Token>

- Defined in ahoi/auth/bankingtokenauth.ts:35
Authenticate and authorize the user with the given installationId against AHOI using OAuth 2.0 protocol. The returned authorization token called 'banking token' is needed to access the AHOI endpoints e.g. to get transactions.
see: https://banking-sandbox.starfinanz.de/ahoi/docs/cookbook/index.html#authentication

memberof

AhoiBankingTokenService

Parameters
- installationId: string
Returns Promise<Token>