Note
An API is most simply defined as: “The way two pieces of software communicate with each other.”
The PainChek API (Application Programming Interface) provides a means for third party systems to integrate with the PainChek system. The API can be used to add, edit or view users, patients, assessments and other details.
The following diagram shows the API used within the PainChek system and how it can be used to integrate with third-party systems:
In the diagram above, you can see how the PainChek mobile apps (on iOS and Android) and the PainChek Portal both use the PainChek API to fetch data from or save data to the PainChek database. That same API can also be used to integrate a third party system - e.g. a Care Management System (CMS) - with PainChek.
The PainChek API is a RESTful (Representational State Transfer) API, using standard web technologies (JSON formatted data exchanged using the HTTP protocol).
For an overview of how our integrations work, continue to About Integrating with PainChek.
Note
To get straight into the technical talk, take a look at Getting Started, or dive into our full guides: