Application Programming Interface (API)

APIs provide a mechanism for interacting with REDCap directly without using the menus and user interface. The REDCap API can be used to: import external data and metadata into a project, export data and metadata from a project, and to interact with the mobile application.

API tokens are issued per user, per project, and do not transfer between projects and cannot be used by another user.

• Project users must have appropriate user rights to request an API token

Open

• API tokens can be requested by users within the project from the left-hand Applications menu

Open

• Please contact a REDCap administrator to discuss any API needs

• No identifiable data can be exported from this environment, including through the API

Integrated Services

(REDCap) Mobile Application

The REDCap Mobile App is an app that can be installed on an Android or iOS tablet or mobile device so that data may then be collected in an offline fashion on that device. At some point later on, it may then be synced back to this project on the REDCap server. The app is most useful when data collection will be performed where there is no Internet service (e.g., no WiFi or cellular service) or where there is unreliable Internet service.

More information on the Mobile App and other REDCap mobile device applications can be found at https://projectredcap.org/software/mobile-app/ , which includes in-depth guides and the Mobile App security documentation.

Project users must have appropriate user rights to access the Mobile App

Open

The REDCap Mobile App management page can be accessed from the Applications section in the left-hand menu. Within the management page, there are steps to follow and videos to provide instructions on how to set up the Mobile App on your devices.

Open

The target audience for the Mobile App is data collectors. The survey settings applied in the Web Application (i.e. accessing REDCap from a typical web browser) do not transfer to the Mobile App. The best practice is for data collectors to utilize the app and conduct surveys via interview, not participant direct data entry.

(REDCap) MyCap

MyCap is a participant-facing mobile application (on iOS and Android) used for data collection and the automated administration of active tasks (activities performed by participants using mobile device sensors under semi-controlled conditions). All data collected in the MyCap app are automatically sent back to the ASU REDCap server as soon as internet connection is available (i.e., it can also be used for offline participant data collection). MyCap is a no-code solution for research teams with frequent participant contact. MyCap also facilitates participant engagement and retention by providing quick access to project staff and two-way communications (e.g., messaging and announcements) within the app. MyCap is available on any iOS device (iOS v11.0+) and any Android device (Android v8.0+). For more information visit MyCap: Mobilizing the Participant Voice.

Mosio

Mosio is a text messaging software for researchers, providing Short Messaging Service (SMS) to create automated and interactive text message programs to improve adherence, engagement, and data collection in your studies. They specialize in research communications automation, helping researchers improve engagement, adherence, and data collection in studies.

Mosio - Text Messaging Solutions for Research | Clinical Trials | Behavioral Research

Mosio Features & Benefits to Researchers | Text Messaging for Research

Read through the language within REDCap

Navigate to the Mosio website at Mosio's Direct Integration with REDCap and read through the description of the service and their helpful FAQ.

Sign up for their self-service model or request a consultation.

After a Mosio account is setup, request that Mosio be enabled on your REDCap project by submitting a request with the project ID to ServiceNow.

Read through the language within REDCap

Navigate to the Mosio website at Mosio's Direct Integration with REDCap and read through the description of the service and their helpful FAQ.

Sign up for their self-service model or request a consultation.

After a Mosio account is setup, request that Mosio be enabled on your REDCap project by submitting a request with the project ID to ServiceNow.

ASU Knowledge Enterprise has an RCD License with Mosio.

ASU Knowledge Enterprise has an RCD License with Mosio

No personally identifiable information should be sent in the SMS communication.

Responses should be gathered using a survey link within the SMS, not through a conversation.

Tableau

http://www.tableau.com

Tableau is a powerful and fastest growing data visualization tool used in the Business Intelligence Industry. It helps in simplifying raw data in a very easily understandable format. Tableau helps create the data that can be understood by professionals at any level in an organization. Tableau is a visual analytics engine that makes it easier to create interactive visual analytics in the form of dashboards. These dashboards make it easier for non-technical analysts and end users to convert data into understandable, interactive graphics

Tango

Twilio

REDCap has the capability to make voice calls and send SMS text messages for surveys and for Alerts & Notifications by using a third-party web service named Twilio (http://www.twilio.com ). In this way, you could invite a participant to take a survey by sending them an SMS message or by calling them on their phone, in which the data would be collected in REDCap directly from their phone without having to use a webpage. There are many different options available for how you can invite participants and how they can take your surveys, either as a voice call survey or as an SMS conversation. You may also send Alert & Notifications to recipients via Voice Call or SMS instead of via email.

Read through the Twilio SMS and Voice Call services for surveys and alerts pop-up instructions.

Open

Only a REDCap administrator can enable the Twilio services in your project.

Please submit a request in ServiceNow for this feature and include this information:

1. ‘Request for project support’

2. ‘Enterprise’ system

3. Enter the REDCap project ID

4. The ‘Details’ field should include

   1. ‘Enable Twilio’

   2. Twilio account SID

   3. Twilio account auth token

   4. Twilio phone number

Once enabled, a new module will appear on the Project Setup tab and you’ll be able to configure the Twilio settings within your project.

Open

For example, you’ll be able to enable the ability to choose how to send certain survey invitations in the ASI configurations including being able to reference a field in the project, allowing participants to choose or change how they receive survey invitations.

To use this feature, you must have a http://Twilio.com user account that is funded with some money (since there is a cost for each phone call made and for each SMS message sent). If you do not have a Twilio account, it is very easy to go to http://Twilio.com and create one.

Twilio account management is handled by the research team and it may be helpful to associate your account with ASU for possible affiliation discounts. ASU has a Master Services Agreement with Twilio that is administered by Enterprise Technology.

There can only be one Twilio phone number associated with a REDCap project at a time.

Some REDCap features, such as piping, field embedding, or date formatting, function on the web browser but do not translate to the SMS codebase. Reading through instructions in REDCap and testing thoroughly are highly encouraged.

Open

External Modules

External Modules are add-on packages of software that can extend REDCap's current functionality, as well as provide customizations and enhancements for REDCap's existing behavior and appearance, either at the system level or project level. These were created and submitted by software developers at various REDCap institutions around the world. The Vanderbilt University Medical Center (VUMC) REDCap development team completes a security scan primarily based on Psalm's Security Analysis with a custom configuration generated on the fly for each module. While no security scan should be considered 100% accurate, the scan is constantly improving and becoming more robust on new submissions. It primarily targets injection vulnerabilities including but not limited to:

• SQL Queries

• Cross Site Scripting

• Cookies

• Headers

• Path Traversal

• Shell Commands

• LDAP Requests

• Curl Calls

The ASU Research Technology, Infrastructure, and Cybersecurity team (RTIC) conducts scans using a script provided by the VUMC REDCap development team and reviews any vulnerabilities prior to downloading or updating the module on the respective environment.

Here is a list of modules available and guidelines for submitting your own module that can be added to our system.

External modules that have been requested, reviewed, and approved for use can be found in the Project Module Manager, accessible from within a REDCap project above the ‘Help & Information’ section, below the ‘Reports’ section.

Access to the Project Module Manager requires Project Design/Setup user rights.

Open

The link below directs to the Project Module Manager within a specific REDCap project. Replace the version number (e.g. 15.1.1) with the current REDCap system version and replace the PID (e.g. 682) with the project you want to navigate to. https://redcap.asu.edu/redcap_v15.1.1/ExternalModules/manager/project.php?pid=682.

To request a new external module not yet available in the system, please submit a request here.

The RTIC team will scan the module and review the results for any vulnerabilities. Scans are conducted on the 15th of every month on a development environment, vulnerabilities are reviewed and system impacts are monitored for 2 weeks.

If it passes, the module will be downloaded on the production environment on the 1st of the month and made discoverable for users to add to any project.

External Modules are not part of the REDCap software but instead are add-on packages. Be aware that the entire risk as to the quality and performance of the module as it is used in your REDCap project is borne by you. If you experience any issues with a module, contact the RTO by submitting a request here.