open_lpsn: Creating 'lpsn_access' objects

In LPSN: API Client for LPSN

Creating ‘lpsn_access’ objects

Description

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

Usage

  open_lpsn(username, password)

Arguments

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

Details

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

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

The usage of the LPSN data is only permitted when in compliance with the LPSN copyright, although this copyright is liberal, see the LPSN web page.

Value

If login is successful, open_lpsn 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://lpsn.dsmz.de/text/copyright

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

https://api.lpsn.dsmz.de/

https://www.keycloak.org/

See Also

refresh

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

Examples

## Examples are deliberately not given here.

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