Skip to content

blueprinthq/partner-samples

Repository files navigation

Blueprint Partner API Samples

This repository includes a sample application that demonstrates how to use the Blueprint Partner API v2 to integrate Blueprint into your application.

Getting Started

  1. Clone the repository.
  2. Make sure you have node and npm installed. This sample application has been built and tested with Node.js v22.
  3. Run npm install to install the dependencies.
  4. Configure your environment settings in a new .env-cmdrc.json file based on the sample with your Blueprint Partner API v2 credentials: cp .env-cmdrc.json.sample .env-cmdrc.json
  5. Set up the environment-specific configuration (see Environment Configuration below).
  6. Run npm run start:staging to start the application using the Blueprint Partner API v2 sandbox environment (or see "Running the Application" section below to see setups for local/staging/prod).

Running the Application

Local Development (without Docker)

Local Environment (default):

npm run start
  • Uses local environment configuration
  • Loads patient data from data/patients.local.json
  • Runs on port 3333

Staging Environment:

npm run start:staging
  • Uses staging environment configuration
  • Loads patient data from data/patients.staging.json
  • Runs on port 3333

Production Environment:

npm run start:production
  • Uses production environment configuration
  • Loads patient data from data/patients.production.json
  • Runs on port 3333

Application Access

Once running, access the application at: http://localhost:3333

The application will redirect you to the login page where you can authenticate with the configured clinician credentials.

Environment Configuration

The application uses environment-specific configurations stored in .env-cmdrc.json:

  • local - Local development environment
  • staging - Blueprint Partner API v2 sandbox environment
  • production - Blueprint Partner API v2 production environment

Each environment loads patient data from corresponding JSON files in the data directory:

  • data/patients.local.json
  • data/patients.staging.json
  • data/patients.production.json

You can update these files with patients that match the clients in the Blueprint clinic that you are connecting your partner application to.

Developer Notes

This sample application demonstrates typical integration scenarios:

  1. Host the embedded UI in your application and let Blueprint take care of the rest ("drop-in UI Only").
  2. Host the embedded UI in your application customize how the UI integrates with your application front end ("UI Only").
  3. Host the embedded UI in your application and deepen the integration by using the API ("UI + API").
  4. Build your own UI and completely customize the integration via the API ("API Only").

Review Blueprint Partner API v2 documentation at https://developer.blueprint.ai for more information and API reference.

About

Sample applications using the Blueprint partner platform

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors