Set the user's API subscription key in order to make the API calls.

The API subscription key will be stored as an environment variable named "DTM_SUBSCRIPTION_KEY".

Usage

set_subscription_key(..., key = NULL)

Arguments

...

Any argument here is ignored. It exists solely to discourage typing in the subscription key directly, e.g. set_subscription_key("mysubscriptionkeyhere"), since doing so will only result in the user being prompted to type the subscription key in a graphical user interface. Rather, if the user wishes to set the subscription key through the console / by programmatic means, then the user must explicitly pass the argument to the key parameter as a named parameter. E.g. set_subscription_key(key = "mysubscriptionkeyhere").

key

Either NULL or a string representing the key. NULL is preferable: using it will prompt the user to type the subscription key in a graphical user interface that masks it.

Value

Nothing. Creates / overwrites an environment variable as a side effect.

Examples

if (FALSE) { # \dontrun{
# Generally, calling set_subscription_key() without the key as an argument is best, 
# as the user can then be prompted to input the key without typing it directly
# into the console, making it more secure and less likely to exposed.
set_subscription_key()
} # }