Skip to contents

Creates a configuration object for requests to the Zotero Web API. The object stores the user identifier, API key, and an optional request performer used by tests or alternative transports. Arguments may be passed explicitly or read from environment variables, which supports interactive, scripted, and agent-driven use.

Usage

zotConfig(
  userID = Sys.getenv("ZOTERO_LIBRARY_ID"),
  key = Sys.getenv("ZOTERO_API_KEY"),
  performer = NULL
)

Arguments

userID

Zotero user identifier. The default reads ZOTERO_LIBRARY_ID.

key

Zotero API key. The default reads ZOTERO_API_KEY.

performer

Optional function used by zotRequest() instead of the package HTTP transport.

Value

An object of class zotConfig.

Examples

Config <- zotConfig(userID = "42", key = "example-key")
Config
#> <zotConfig> userID: 42 | key: <redacted> | api: https://api.zotero.org