Skip to contents

OpenM++ CPAC API Connection

Source: R/API-CPAC.R
use_OpenMpp_CPAC.Rd

Register a connection to the OpenM++ Web Services (OMS) Application Programming Interface (API) running on the CPAC cloud-based server.

Usage

use_OpenMpp_CPAC(
  url = Sys.getenv("OPENMPP_CPAC_URL"),
  api = Sys.getenv("OPENMPP_CPAC_API"),
  user = Sys.getenv("OPENMPP_CPAC_USER"),
  pwd = Sys.getenv("OPENMPP_CPAC_PWD"),
  ...
)

Arguments

url

URL for making login requests. See Details for more instructions.

api

URL for making API requests. See Details for more instructions.

user

User name for logging into remote API. See Details for more instructions.

pwd

Password for logging into remote API. See Details for more instructions.

...

Not currently used.

Value

Nothing, invisibly. Behind-the-scenes, an instance of the OpenMppCPAC R6 class is created. This objects should not be accessed directly by the user, instead, the package internally uses these connections to communicate with the OpenM++ API.

Details

A user name and password (pwd) are sensitive information and should not be shared. To avoid hard-coding your user name and password into your R scripts, we recommend declaring this information in your global or project-specific .Renviron file. The same approach may be used to declare your URLs for making API requests. While these URLs are typically not sensitive information, keeping all of this information in one place makes sense for consistency. For remote API connections to CPAC, set the following environment variables in your .Renviron files:

  • OPENMPP_CPAC_URL: URL for logging into a remote API connection.

  • OPENMPP_CPAC_API: URL for making remote API requests.

  • OPENMPP_CPAC_USER: User name for logging into the remote API connection.

  • OPENMPP_CPAC_PWD: Password for logging into the remote API connection.

Examples

if (FALSE) { # \dontrun{
use_OpenMpp_CPAC()
} # }