espa_inventory_login: espa_inventory_login

In espa.tools: Wrappers for the USGS ESPA APIs and Earth Explorer

Description

R wrapper for USGS/EROS Inventory Service Login API.

Usage

espa_inventory_login(usgs_eros_username, usgs_eros_password, verbose = F)

Arguments

usgs_eros_username	Character. Your USGS registration username. You can register for an account at https://espa.cr.usgs.gov
usgs_eros_password	Character. Your USGS registration password. WARNING: USING THIS WITH R IS NOT PARTICULARLY SECURE.
verbose	Logical. Verbose execution? Default=F.

Details

Upon a successful login, an API key will be returned. This key will be active for one hour and should be destroyed upon final use of the service by calling the logout method. Users must have "Machine to Machine" access, which is established in the user's profile.

Value

Character of the API KEY needed by the other inventory APIs.

Author(s)

Jonathan A. Greenberg ([e-mail]) (wrapper) and USGS ESPA Developers (API and documentation)

References

https://earthexplorer.usgs.gov/inventory/documentation/json-api#login

See Also

espa_inventory_logout

Examples

## Not run:  
# Get API KEY (required EROS username/password): 
apiKey=espa_inventory_login("myusername","mypassword")

## End(Not run)

espa.tools documentation built on May 2, 2019, 5:54 p.m.