rd_handshake: Get Bearer Key from Terminal

In GreenGrassBlueOcean/RefinitivR: Connect to Datastream and python Eikon api in r

Get Bearer Key from Terminal

Description

The ‘rd_handshake' function manages bearer tokens by verifying the existing token’s validity using 'rd_VerifyToken'. If the token is invalid or expired, or if 'force = TRUE', it performs a handshake to request a new token from the Refinitiv API. The function stores the new token and its expiration time for future use.

Usage

rd_handshake(debug = FALSE, force = TRUE)

Arguments

debug	Logical. If 'TRUE', prints URLs and additional debugging information for JSON requests. Defaults to 'FALSE'.
force	Logical. If 'TRUE', forces fetching a new token even if an existing valid token is present. Defaults to 'TRUE'.

Details

The function first checks if an existing bearer token is present and valid. If so, and if 'force = FALSE', it reuses the existing token. Otherwise, it initiates a handshake with the Refinitiv API to obtain a new token. The new token and its expiration time are stored in global options for subsequent use.

Value

A list with the following fields:

access_token

Bearer token (key).

expires_in

Number of seconds until the token expires.

token_type

Type of token (e.g., "bearer").

Examples

## Not run: 
# Fetch a new token regardless of existing tokens
response <- rd_handshake(force = TRUE, debug = TRUE)
print(response)

## End(Not run)

GreenGrassBlueOcean/RefinitivR documentation built on Dec. 16, 2024, 2:32 a.m.