Testing

Overview

We offer a test mode so you can build and test your API integration in a simulated environment without interacting with real customers, practitioners, and patients.

Authentication and secret keys

API requests are distinguished by the secret key provided in the Authorization header of every API request. test mode keys are prefixed with ch_sk_test and live mode keys are prefixed with ch_sk_live.

👍

You can use the secret key ch_sk_test_quickstart to get started with Railway's APIs without registering.

Test vs Live modes

Type	Behavior	When	How
test	In this mode, you can never interact with real customers, practitioners, or patients. All data returned and actions executed occur within a simulated environment.	Use this mode when you are building and testing your API integration in a development environment.	Use test identifiers. Don’t use real PHI, NPIs, or other identifiers.
live	In this mode, you are interacting with your real customers, practitioners, and patients.	Only use this mode in your production environment.	It's safe to use real identifiers, PHI, etc.