backend_connect: Connect to an annotator backend API

View source: R/connect_backend.r

backend_connectR Documentation

Connect to an annotator backend API

Description

Connect to a backend API and request or refresh an authentication token. The typical mode of use is to provide the 'host' (url) of the server and a 'username'. The password will then be requested in a separate prompt.

Usage

backend_connect(host, username, token = NULL, .password = NULL)

Arguments

host

The hostname, e.g. http://localhost:5000

username

An existing username on the host server

token

An existing token to authenticate with. If given (and valid), no password has to be entered

.password

Optionally, the password can be passed as an argument, but this is not recommended.

Value

Nothing. Stores API token in env


ccs-amsterdam/ccsAnnotator documentation built on March 19, 2024, 2:14 a.m.