authenticate: Authenticate yourself with BrandsEye

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/authentication.R

Description

Provides a means to authenticate yourself with the BrandsEye API. This is done using an API key that your account manager representative has provided for you.

Usage

1

Arguments

key

Your API key. If you don't know this, your account manager can give you one.

save

Set to true if you would like this key to be saved to disc and loaded automatically the next time that you use this library.

Details

All authentication with the BrandsEye API is done via a special, user specific key. This key can be provided to you by your account manager.

It's possible to also have your key saved to disc and automatically loaded for you when you next use the library. Set the save parameter to TRUE in order to do this.

If you would like to see who you are currently logged in as, see the whoami() function.

Value

Your authentication details

Author(s)

Constance Neeser

See Also

account_manager()

Examples

1
2
3
4
5
6
## Not run: 

authenticate("adfd42345f534fgdfgd")


## End(Not run)

brandseye/brandseyer2 documentation built on Sept. 5, 2021, 2:15 p.m.