Skip to contents

Generate a base request object for the vectorbyte databases

Source: R/vb_basereq.R
vb_basereq.Rd

This request is used as the basis for all calls to the vectorbyte API. It does not contain any tokens or session ids, and thus can be regenerated at any time.

Usage

vb_basereq(
  baseurl = "https://vectorbyte.crc.nd.edu/portal/api/",
  useragent = "ROHVBD",
  unsafe = FALSE
)

Arguments

baseurl

the base url for the vectorbyte API

useragent

the user agent string used when contacting vectorbyte

unsafe

disable ssl verification (should only ever be required on Linux, do not enable this by default)

Value

Returns an httr2 request object, pointing at baseurl using useragent

Author

Francis Windram

Examples

if (FALSE) { # \dontrun{
basereq <- vb_basereq(
  baseurl="https://vectorbyte.crc.nd.edu/portal/api/",
  useragent="ROHVBD")
} # }