dimensionsR (version 0.0.3)

dsAuth: Obtain an API token from dimensions.ai

Description

It generates a token request to dimensions.ai using account and password.

Usage

dsAuth(
  username = NULL,
  password = NULL,
  key = NULL,
  auth_endpoint = "https://app.dimensions.ai/api/auth.json",
  verbose = FALSE
)

Arguments

username

is a character.

password

is a character.

key

is a character.

auth_endpoint

is a character. It contains the authentication endpoint url of Dimensions. Default is auth_endpoint = "https://app.dimensions.ai/api/auth.json"

verbose

is logical.

Value

a character cointaining an token o use dimensions API.

To obtain a free access to Dimenions API fro no commercial use, please visit: https://ds.digital-science.com/NoCostAgreement

For more extensive information about Dimensions API, please visit: https://www.dimensions.ai/dimensions-apis/

See Also

dsApiRequest

dsQueryBuild

dsApi2df

Examples

# NOT RUN {
# Obtain a token by username and password
# }
# NOT RUN {
token <- dsAuth(username = "[e-mail]", password = "mypassword")
# }
# NOT RUN {
# Obtain a token by API Key

# }
# NOT RUN {
token <- dsAuth(key = "myapikey")
# }
# NOT RUN {
# }