Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Contact Us
  • Home
  • CDMS
  • Castor CDMS Manual
  • Link Castor to another application

Castor EDC/CDMS Application Programming Interface (API)

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • CDMS
    Castor CDMS Manual Castor CDMS Calculations Manual Frequently Asked Questions Articles for Data Managers Castor CDMS Compliance Release Documents
  • eConsent
    Castor eConsent Manual Castor eConsent Compliance Release Documents
  • SMS
    Castor SMS Manual Castor SMS Compliance Release Documents
  • Castor Connect
    Castor Connect Compliance Release Documents Castor Connect Manual Castor Connect - Participant Quick Start Guide
  • Helpdesk
    News Other Resources Castor products knowledge resources
  • Status page
  • Completing a Study
+ More

Table of Contents

Authentication Documentation & testing endpoints Troubleshooting

Castor CDMS has an Application Programming Interface (API) that supports authentication and authorization of API calls through the industry standard OAuth2. In this article you can learn about its authentication, documentation, and troubleshooting.

Authentication

Generate an API Client ID and Client Secret through your 'User Settings' page:

 

With this client ID and secret you can request an access token, which you can use to access your Castor data. The access token is valid for 5 hours before it expires. 

 

Please note that the Client ID and Secret grant the same access to your data as your own username and password. Please treat them as such and do not hand them out to third parties, unless you want to allow them to have access to your data via your account.

 

 

Documentation & testing endpoints

All documentation for the API can be found on https://data.castoredc.com/api. If your study is on a different server, please make sure you use the right URL for the documentation:

Server Documentation page
EU data.castoredc.com/api
UK uk.castoredc.com/api
US us.castoredc.com/api
AU au.castoredc.com/api

 On the documentation page you can try out the endpoints:

  1. Before you start, please make sure that you're a user in a study with the appropriate access rights.
  2. Click on the green Authorize button on the right:
  3. Enter your API credentials in the popup.
  4. Click on one of the endpoints and click on "Try it out". 
  5. Enter data for the parameters if applicable.
    • See article Where can I find IDs for the study/field/repeating data instance/... for the API? about where you can find the right IDs.
    • See article Parameters used in the API about the differences between study forms, repeating data (instances), surveys (instances), and survey packages (instances).
  6. Click "Execute". You will see the response below the endpoint.

The API is programmed to allows users using third party encryption providers like Trusted Reversible Encryption Service (TRES) to work with data on their premises. 

 

It also allows to filter the results based on the participant id and the archive/non archive property.

Troubleshooting

If you run into errors that you cannot solve, check if they are listed in our API Troubleshooting article. If you have any other issues, please contact us at support@castoredc.com.

Also, please consider reviewing the API changelog for further reference on the recent changes.

  • API Changelog
cdms api castor edc

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Introduction to R, RStudio and RShiny - Create your own dashboards
  • Import data from electronic health records (EHR) in EDC/CDMS
  • Using the Castor API R package for data analysis
  • Castor EDC/CDMS API Rate Limiting
ISO 27001
FDA - 21 CFR part 11
ICH GCP compliant
HIPAA compliant
CDISC
ISO 9001
gdpr compliant

Products & Industries

  • Electronic Data Capture (EDC)
  • ePRO
  • eConsent
  • Decentralized Clinical Trials (DCT)
  • Clinical Data Management
  • Medical Device & Diagnostics
  • Biotech & Pharma
  • CROs
  • Academic Research

Resources

  • Thought Leadership
  • Blog
  • Castor Academy
  • Knowledge Base

 

Company

  • About Us
  • Careers
  • News
  • Contact Support
  • Contact Us

Legal & Compliance

  • Terms of Use
  • Privacy & Cookie Statement
  • Responsible Disclosure Policy
  • Good Clinical Practice (GCP)
  • ISO Compliance Certificates
  • GDPR & HIPAA Compliance
  • Security Statement

© 2022, Castor. All Rights Reserved.

Follow us on social media


Knowledge Base Software powered by Helpjuice

Definition by Author

0
0
Expand