get_api_key: Get previously saved API keys

Description Usage Value Warning Author(s) See Also Examples

View source: R/api_structure.R

Description

Function to get the previously saved API key. It has the advantage that it is not necessary to explicitly publish the key in the users code. Just do it one time and you're set. To save an API, use the save_api_key function. To remove a previously saved key, use the remove_api_key function.

Usage

1

Value

Returns the saved API key in the environment. If no API key has been saved, returns NULL value.

Warning

Please be careful when dealing with API keys and other secrets & tokens - keep them private and do not publish them.

Author(s)

Matthias Brenninkmeijer - https://github.com/matbmeijer

See Also

save_api_key, remove_api_key

Examples

1
2
3
4
5
6
## Not run: 
get_api_key(type="genderize")
get_api_key(type="agify")
get_api_key(type="nationalize")

## End(Not run)

DemografixeR documentation built on July 8, 2020, 5:18 p.m.