checkKey: Check the Brickset API key.

In brickset: Interface with the Brickset API for Getting Data About LEGO Sets

Check the Brickset API key.

Description

You can request an API key on the Brickset website here: https://brickset.com/tools/webservices/requestkey/

Usage

checkKey(key = getOption("brickset_key"))

Arguments

key	the Brickset API key

Details

The API key can be passed as function parameter or may be set globally using:

options(brickset_key = YOUR_API_KEY)

Brickset API documentation is available here: https://brickset.com/article/52664/api-version-3-documentation

Value

TRUE if the API key is valid.

Examples

## Not run: 
options(brickset_key = 'BRICKSET_KEY',
        brickset_username = 'BRICKSET_UERNAME',
        brickset_password = 'BRICKSET_PASSWORD')
checkKey() # Will return TRUE if the credentials are correct

## End(Not run)

brickset documentation built on May 29, 2024, 6:13 a.m.