get_session_key: Get a LimeSurvey API session key

In limonaid: Working with 'LimeSurvey' Surveys and Responses

Get a LimeSurvey API session key

Description

This function logs into the LimeSurvey API and provides an access session key. It was adapted by Gjalt-Jorn Peters from a function originally written by Andrew Heiss.

Usage

get_session_key(
  username = getOption("lime_username"),
  password = getOption("lime_password"),
  hostname = getOption("lime_api")
)

Arguments

username	LimeSurvey username. Defaults to value set in options().
password	LimeSurvey password. Defaults to value set in options().
hostname	The host to use (if not using the one specified in the options). If no hostname is specified in the 'lime_api' option and no host name is passed as hostname, the subdomain stored in limonaid::opts$get("ls_subdomain") will be combined with the domain stored in limonaid::opts$get("ls_domain") to create the host name. You can change these using the limonaid::opts$set() function.

Value

API token

Examples

## Not run: 
get_session_key()

## End(Not run)

limonaid documentation built on June 10, 2025, 9:10 a.m.