Making API Calls

After retrieving your API token you can then access the API (see Authenticating with the API for details). The API Documentation will provide details on what requests and responses should look like for interacting with the API.

Available Documentation:

The documentation is connected to a testing instance of our server which allows you to test out the calls and experiment with the application as you build out your integration. You will be provided with credentials for this testing environment first to configure your integration. The API reference provides form fields corresponding to the request payload for the endpoint. As you fill these in, you will see the code samples populate with the information. You can use these as a basis for your integration.

In addition, you will also be provided with the site ids, trial ids, and sponsor site ids to which you have access to send referrals. These ids are available for you to retrieve using the Get Referral Site List API (hyperlink). All trial and site ids are specific to the sites and trials of the integrated environment. For this reason, these parameters will need to be updated when moving from the testing environment to the production environment.

As mentioned in the authentication guide, all calls will need a JWT provided in the "authorization" header. Use your credentials to invoke the get token API. Then, simply click on the authenticate icon on the endpoint you want to call and copy and paste the JWT into the form field:

After successful testing and sign-off, the integration will be moved to production.