Staging and Testing

The CarePortals API utilizes a single production environment for all interactions. To ensure data integrity and provide a safe space for development, we separate live data from test data using dedicated staging organizations.

API Environment

All API calls, whether for your staging or production organization, are made to the same base URL. There are no separate servers or endpoints for testing.

The base URL for the CarePortals API is:

 <https://api.careportals.com>

Your Organizations

When you are onboarded, you will be provided with credentials for two distinct organizations that operate within our production environment.

Staging Organization

This organization is your dedicated sandbox for all development and testing activities. Use it to build and validate your integration, perform end-to-end testing, and train users without the risk of affecting real patient data. Data created in your Staging Organization is completely isolated from your Production Organization.

Production Organization

This organization is for live use only. All API calls made using these credentials will interact with real patient data and trigger live workflows. This environment should only be used once your integration has been fully tested and is ready for launch.

Credentials and Setup

To get started, you must request your organization credentials directly from us. We will create and securely share the username and password pairs required for authentication with both your Staging and Production organizations.