Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

API Overview

The cURL API (Client URL) is a command-line tool that enables efficient data transfers between Ripple and third-party systems. It helps research teams manage bulk data imports and exports, reducing manual work and maintaining data accuracy. When using an API, you can import or export data in bulk without having to go into Ripple to do so.

🔍. What is an API?

  • API stands for Application Programming Interface.

  • It allows computers or programs to communicate with each other with minimal human intervention.

  • APIs are commonly used for bulk importing and exporting data between systems.


Types of Ripple cURL APIs

Ripple's cURL API works has two components:

1. Export

    • Exports data from a study or the Registry.

    • May be used to move data from Ripple into systems like EDC, CTMS, or CRMs.

2. Import

    • Imports data from external systems into Ripple.

    • Supports adding or updating participants from third-party sources, like recruitment databases, data collection systems, and more.

Benefits for Research Teams

  • Decrease Duplicative Data Entry – Avoid manual data entry across multiple platforms
  • Improved Accuracy – Consistent data across Ripple and other systems
  • Automated Workflows– Scripted data transfers save time and reduce errors

NOTE:  This is not an integration. You cannot click a button in Ripple and have it automatically update a third-party system (or vice versa). API interactions must be initiated through scripts or manual commands.

Preparing to Use the cURL API

Step 1: Choose Where to Run the Command

Option A: An external site such as Postman

      • Ideal for exploring and formatting cURL commands

      • Easier to share with team members (export or paid plans)

Option B: Command-Line Interface

      • Use Terminal (Mac) or Command Prompt (Windows)

      • Best for advanced users and script automation

Step 2: Confirm User Permissions

Only the following roles can use Ripple’s cURL API:

      • Site Admins

      • Site Managers (with study access)

BEST PRACTICES:

  • Schedule routine data transfers (e.g., weekly)
  • Collaborate with IT to automate scripts securely
  • Validate data formatting and permissions before running commands
  • Use version control or documentation for reusable scripts
  • Familiarize yourself with the Import and Export tools. The API follows the same rules and formatting requirements

📚 Related Articles