suso_set_key: Set Credentials

View source: R/suso_api_credentials.R

suso_set_keyR Documentation

Set Credentials

Description

Sets API credentials so it's available for all API calls. See details

Usage

suso_set_key(
  suso_server = "",
  suso_user = "",
  suso_password = "",
  suso_token = ""
)

Arguments

suso_server

Survey Solutions server address

suso_user

Survey Solutions API user

suso_password

Survey Solutions API password

suso_token

If Survey Solutions server token is provided suso_user and suso_password will be ignored

Details

Use suso_set_key to make API keys available for all the suso_ functions, so you don't need to specify the credentials parameter within those functions. The server address can be provided with or without https:\ suffix, nevertheless if it is missing, then the suffix will be added.

In case suso_token is provided, only token authentication will be attempted. For details on token authentication in Survey Solutions please see https://docs.mysurvey.solutions/headquarters/accounts/token-based-authentication/.


michael-cw/SurveySolutionsAPI documentation built on Jan. 14, 2024, 2:58 a.m.