HPZoneAPI (version 1.1.0)

HPZone_setup: Initialisation function to define API credentials. This function must be called before anything else, as the details supplied in this call are required for use. Note that client_id and client_secret should preferably not be supplied in this call, but rather stored using [HPZone_store_credentials()].

Description

Initialisation function to define API credentials. This function must be called before anything else, as the details supplied in this call are required for use. Note that client_id and client_secret should preferably not be supplied in this call, but rather stored using [HPZone_store_credentials()].

Usage

HPZone_setup(
  client_id = NA,
  client_secret = NA,
  standard = "standard",
  extended = "extended",
  token_url = "https://connect.govconext.nl/oidc/token",
  data_url = "https://api.hpzone.nl:8899/Edie"
)

Value

No return value.

Arguments

client_id

Client ID as supplied by InFact.

client_secret

Client secret as supplied by InFact.

standard

Name of the standard scope. Default: "standard"

extended

Name of the extended scope. Default: "extended"

token_url

Address of the token server.

data_url

Address of the data server.

Examples

# Not recommended:
HPZone_setup("id", "secret")

# Recommended:
if (FALSE) {
HPZone_store_credentials() # call once
HPZone_setup() # will automatically read stored credentials
}