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

cURL API Overview

Ripple’s cURL API (Client URL Application Programming Interface) is a powerful tool that allows you to transfer data between Ripple and a third-party system using command-line operations. This article provides an overview of how Ripple’s cURL API works and the basic requirements for exporting and importing data efficiently.

What Is the cURL API?

The cURL API enables you to automate the transfer of data to and from Ripple via your computer’s terminal or command-line interface. It uses HTTP requests to:

  • Export data from Ripple into a CSV file

  • Import data into Ripple from a third-party system

The cURL API is ideal for bulk data transfers and helps eliminate the need for manual entry within the Ripple interface. This reduces duplicate work and helps ensure consistency across systems such as:

  • Electronic Data Capture (EDC) systems

  • Clinical Trial Management Systems (CTMS)

  • Customer Relationship Management (CRM) tools

NOTE: The cURL API does not enable real-time sync between systems. You must separately run import and export commands for each direction of data transfer.

Export cURL API

The Export cURL API allows you to extract data either from the Registry or from a specific study in Ripple.

Requirements:

  • You must be a Site Admin or Site Manager

  • You must have access to the study you're exporting from

How It Works:

  1. Write a cURL command that specifies:

    • The data source (Registry or study)

    • The variables you want to export

    • Your credentials or authorization key

  2. Run the command in your terminal.

  3. The result will be a downloadable CSV file.

  4. You can then import this data into your third-party system.

NOTE: You cannot filter the exported data prior to the export. All data for the selected variables will be included in the output file.

Import cURL API

The Import cURL API allows you to upload data from a third-party system into Ripple.

Requirements:

  • You must be a Site Admin or Site Manager

  • Data must follow Ripple’s Import Tool Data Dictionary format

How It Works:

  1. Format your external data to match Ripple’s import requirements to the Data Dictionary rules.

  2. Write a cURL command that includes:

  3. Run the command to import the data into Ripple.

Permissions and Access

  • Only users with Site Admin or Site Manager roles can use the cURL API.

  • You must have permissions for the study you're trying to access.

  • Each cURL command must include a valid authorization key.

Related Resources