open_bacdive: Creating 'bacdive_access' objects

In BacDive: API Client for BacDive

Creating ‘bacdive_access’ objects

Description

This package uses ‘bacdive_access’ objects for managing the access to the BacDive API. These objects are variants of ‘dsmz_keycloak’ objects.

Usage

  open_bacdive(username, password)

Arguments

username	Character vector of length 1.
password	Character vector of length 1.

Details

The actual usage of ‘bacdive_access’ objects is demonstrated by querying the BacDive API. See the examples given for the according functions, such as fetch.

The usage of the BacDive API requires registration, although registration is free and easy to accomplish. See the BacDive API web page.

The usage of the BacDive data is only permitted when in compliance with the BacDive terms and conditions, see the BacDive web page.

Value

If login is successful, open_bacdive returns a new ‘dsmz_keycloak’ object, if otherwise an error results. Login is, of course, only successful if a user of the given name is already registered with the given password.

References

https://bacdive.dsmz.de/about

https://bacdive.dsmz.de/mailinglist/subscribe

https://api.bacdive.dsmz.de/

https://www.keycloak.org/

See Also

refresh

Other query.functions: fetch, request, retrieve.bacdive_access, upgrade.bacdive_access

Examples

## Examples are deliberately not given here.

BacDive documentation built on April 29, 2022, 3 a.m.