CarePortals offers an API-first platform, meaning all features and functionalities available on the user and admin interfaces are also programmatically accessible through the API. This guide provides an overview of the four different API layers available to developers.
API Layers
CarePortals has four distinct API layers, each serving a specific purpose:
Public API
This layer is included in standard customer packages and is used for fetching specific data like appointments, canceling appointments, starting a checkout process, or retrieving product information by ID.
Patient API
Provides functionalities related to the patient portal, such as patient sign-in and login, creating orders, submitting intake forms or questionnaires, making payments, and managing subscriptions. This API is commonly used to build custom checkouts and patient portals from scratch.
EMR API
Provides access to functionalities found on the EMR side of the platform, such as creating and managing files, creating consultations, managing patient orders, and retrieving drug catalog information.
CRM API
This layer primarily intended for administrative and configuration tasks. It allows for actions like creating product records within the system via the API.
Getting Started
To begin using the CarePortals APIs, you should understand the following key areas of the documentation: