...
Costs associated with using APIs
Generally APIs are enabled out-of-the-box. However, but there may be disabled if not required.There may be a cost associated with the use of certain APIs.
The Recruit API may be disabled if not required.
Learning API Functions
Each of the API documentation pages contain information covering the scope and purpose of each interface. Additionally, there is an embedded Swagger UI client on the page with the purpose of allowing customers a simple interactive way to try out certain functions and learn how the API can be used. This video provides a quick demonstration on how to use the embedded functions.
...
| Note |
|---|
We discourage the practice of customers creating, sharing, and soliciting use of integration user accounts that contain API role actions outside of site organization teams. |
Performance and Limitations
ClinSpark APIs were designed to allow customers to be reliant on them for common study recruitment and operational workflows. Some of those needs may be related to time sensitive tasks. Invoking endpoints programmatically may exceed the normal limitations imposed through using the user interface.
There are no request limits enforced or network throttling in place for API calls. However, this is an area under evaluation by the product team as more of our customers use the APIs; limits may be imposed in future.
To a certain extent, the performance of the APIs are based on the functions used. For example, the Report API allows for specifying one or more parameters as part of the request, which can influence the output to a specific set of subjects or timepoints in a study. Requests for fewer data points will result in a quicker retrieval of results. Additional performance considerations using the Report API can reviewed here: https://foundryhealth.atlassian.net/wiki/spaces/DOCS/pages/3709665444/Report+API#Performance
There may be additional limitations or performance implications to consider with a high volume of API requests. Customers are encouraged to reach out to IQVIA support teams on this topic to discuss and determine if there are performance risks associated with intended use.