R: Obtain an API token from dimensions.ai

dsAuth {dimensionsR}

R Documentation

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/

Examples


# Obtain a token by username and password
## Not run: 
token <- dsAuth(username = "my.email@my.domain", password = "mypassword")

## End(Not run)

# Obtain a token by API Key

## Not run: 
token <- dsAuth(key = "myapikey")

## End(Not run)