- Dimitar Dimitrov, Systems Designer
- Jeremy Alphonse, EDC Project Analyst
Enterprise Research Infrastructure & Services (ERIS)
The REDCap Application Programming Interface, API, allows external applications to connect to REDCap remotely, and is used for programmatically retrieving or modifying data or settings within REDCap, such as performing automated data imports/exports for a specified REDCap project. Programmers can use the REDCap API to make applications, websites, apps, widgets, and other projects interact with REDCap. Programs talk to the REDCap API over HTTP, the same protocol that your browser uses to visit and interact with web pages.
The Data Entry Trigger, DET, provides a way for REDCap to trigger a call to a remote web address (URL), in which it will send a HTTP POST request to the specified URL whenever *any* record or survey response has been created or modified on *any* data collection instrument or survey in this project. Its main purpose is for notifying other remote systems outside REDCap at the very moment a record/response is created or modified, whose purpose may be to trigger some kind of action by the remote website, such as making a call to the REDCap API.
To get started using the REDCap API, review the General API Info via REDCap API Help Page https://redcap.partners.org/redcap/api/help/index.php. There is also an API Playground page in each of your REDCap projects, in which the playground will allow you to experiment with the REDCap API and see the range of its functionality without even having to write any code.
Main Objective: Provide support, best practices, and guidance to REDCap End-Users utilizing the REDCap API and DET
- Learn how to access REDCap's API, DETs
- Learn how to best implement the API, DETs
- Review updates to API features in REDCap v7.0
- Understand the current limitations and when to contact ERIS or Research CORE for additional support
Target audience: Researchers that have evaluated and decided to use REDCap and/or have started a REDCap project. Researchers with basic level programming experience.