ryt_auth_configure | R Documentation |
These functions give more control over and visibility into the auth
configuration than ryt_auth()
does. ryt_auth_configure()
lets the user specify their own:
OAuth app, which is used when obtaining a user token.
API key. If rytstat is de-authorized via ryt_deauth()
, all
requests are sent with an API key in lieu of a token.
See the vignette
How to get your own API credentials
for more.
If the user does not configure these settings, internal defaults
are used.
ryt_oauth_app()
and ryt_api_key()
retrieve the
currently configured OAuth app and API key, respectively.
ryt_auth_configure(app, path, api_key) ryt_auth_cache_path() ryt_open_auth_cache_folder() ryt_api_key() ryt_oauth_app()
app |
OAuth app, in the sense of |
path |
JSON downloaded from Google Cloud Platform Console, containing a
client id (aka key) and secret, in one of the forms supported for the |
api_key |
API key. |
ryt_auth_configure()
: An object of R6 class
gargle::AuthState, invisibly.
ryt_oauth_app()
: the current user-configured
httr::oauth_app()
.
ryt_api_key()
: the current user-configured API key.
Other auth functions:
ryt_auth()
,
ryt_deauth()
## Not run: # see and store the current user-configured OAuth app (probaby `NULL`) (original_app <- ryt_oauth_app()) # see and store the current user-configured API key (probaby `NULL`) (original_api_key <- ryt_api_key()) if (require(httr)) { # bring your own app via client id (aka key) and secret google_app <- httr::oauth_app( "my-awesome-google-api-wrapping-package", key = "YOUR_CLIENT_ID_GOES_HERE", secret = "YOUR_SECRET_GOES_HERE" ) google_key <- "YOUR_API_KEY" ryt_auth_configure(app = google_app, api_key = google_key) # confirm the changes ryt_oauth_app() ryt_api_key() # bring your own app via JSON downloaded from Google Developers Console # this file has the same structure as the JSON from Google ryt_auth_configure(path = app_path) # confirm the changes ryt_oauth_app() } # restore original auth config gs4_auth_configure(app = original_app, api_key = original_api_key) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.