dsAuth: Obtain an API token from dimensions.ai

Description Usage Arguments Value See Also Examples

View source: R/dsAuth.R

Description

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

Usage

1
2
3
4
5
6
dsAuth(
  username,
  password,
  auth_endpoint = "https://app.dimensions.ai/api/auth.json",
  verbose = FALSE
)

Arguments

username

is a character.

password

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

1
2
3
4
## Not run: 
token <- dsAuth(username = "my.email@my.domain", password = "mypassword")

## End(Not run)

dimensionsR documentation built on Aug. 28, 2020, 5:09 p.m.