A Client URL (cURL) API (Application Programming Interface) is a tool for transferring data between Ripple and a third-party system. cURL allows you to exchange data between your device and a server using a command-line interface and your computer’s terminal. It consists of a code, or command, consisting of an HTTP request that allows you to efficiently export data from, or import data into Ripple, in bulk without having to go inside of Ripple. 

There are two cURL APIs: export and import. The Export cURL API allows you to export data from the Registry or a study. Once the data is exported, you can import it into your third-party system. The Import cURL API allows you to take data from a third-party system and import it into Ripple. 

When done in a timely manner, this allows you to make sure that Ripple and your third-party system, such as your Electronic Data Capture system, Clinical Trial Management system, or other CRM, have the same data. This prevents teams from having to double-enter the data and reduces the risk of having discordant data.

On the other hand, the cURL API is a tool for automating how you export or import data. The two systems are not interacting to update each other’s data without the complimentary import or export.

How does the cURL API work?

To use the cURL API, you must be a Site Admin or Site Manager with access to the study you’re importing or exporting. The cURL API is built off the Import and Export Tools and has similar rules to Ripple’s Import and Export processes.

Both the Export cURL API and Import cURL API require you to use a cURL command. The cURL command tells Ripple where to export the data from or into, who you are, and what data you’re looking for. 

To use the Export cURL API, you’ll need to tell Ripple if you’re exporting from the Registry or a study, who you are, and which variable(s) you want to export. Like the current export tool, you can export from the Registry only or one study at a time. Once you write your cURL command, you can export the data into a CSV file, at which point you can transform the data and import it into another system. The Export cURL API will give you all of the data from that variable; you cannot filter it until it is exported into the excel. 

To use the Import cURL API, you’ll first need to transform your data from the third-party system’s export into formats that match the Import Tool’s Data Dictionary rules. From there, you’ll write your cURL command to tell Ripple if the data should be imported into the Registry only or just one study.

You can read these articles to learn how to use the Export cURL API and the Import cURL API.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.