api_key: SP2000 API keys

In SP2000: Catalogue of Life Toolkit

Description

Apply for the apiKey variable to be used by all search_* functions and zoology_* functions, register for http://sp2000.org.cn/api/document and use an API key. This function allows users to set this key. Note: The daily API visits of ordinary users are 2000, If you want to apply for increasing the daily API request limit, please fill in the application form http://col.especies.cn/doc/API.docx and send an email to [e-mail] entitled "Application for increasing API Request Times".

Usage

set_search_key(key, db = "sp2000")

Arguments

key	string Value to set apiKey to (i.e. your API key).
db	string Set up the database API, db = c("sp2000","zoology").

Value

A logical of length one, TRUE is the value was set FALSE if not. value is returned inside invisible(), i.e. it is not printed to screen when the function is called.

Author(s)

Liuyong Ding [e-mail]

Examples

## Not run: 
#Set the apiKey variable to be used by all search_* functions
set_search_key("your apiKey",db = "sp2000")

#Set the apiKey variable to be used by all zoology_* functions
set_search_key("your apiKey",db = "zoology")


## End(Not run)

SP2000 documentation built on Nov. 8, 2020, 4:41 p.m.