redcapApiConnection for using the REDCap API [or a direct
connection through an SQL server]redcapConnection(url=getOption('redcap_api_url'), token, conn, project, config=list())url or conn must be specified.project must also be used.httr::POST. This allows the user to set
additional configurations for the API calls, such as certificates, ssl version, etc.
For the majority of users, this does not need to be altered. See Details for more abooptions(redcap_api_url=[your URL here]) in your RProfile.To obtain an API token for a project, do the following:
Enter the 'User Right' section of a project
Select a user
Check the box for 'API Data Export' or 'API Data Import,' as appropriate. A full tutorial on
configuring REDCap to use the API can be found at
Tokens are specific to a project, and a token must be created for each project for which you wish to use the API.
The config argument is passed to the httr::POST argument of the same name. The
most likely reason for using this argument is that the certificate files bundled in httr
have fallen out of date. Hadley Wickham is pretty good about keeping those certificates up
to date, so most of the time this problem can be resolved by updating httr to the most
recent version. If that doesn't work, a certificate file can be manually passed via the
config argument. The redcapAPI wiki has a more detailed tutorial on how to
find and pass an SSL certificate to the API call (
Additional Curl option can be set in the config argument. See the documentation
for httr::config and httr:httr_options for more Curl options.
redcap package.
rcon <- redcapConnection(url=[YOUR_REDCAP_URL], token=[API_TOKEN])
options(redcap_api_url=[YOUR_REDCAP_URL])
rcon <- redcapConnection(token=[API_TOKEN])Run the code above in your browser using DataLab