API smoke test for Modernization API

The nbs-test-api.sh script tests end-to-end API functionality by creating a patient record, searching for it, and marking it inactive. Use this test to confirm the Modernization API is responding correctly after deployment.

On this page

  1. Prerequisites
  2. Run the smoke test
  3. Next steps

Prerequisites

To run the smoke test, you need:

  • Authenticated access to your NBS environment
  • A database user that can run API calls
  • A shell environment with curl installed (AWS CloudShell works if you use it, or any system with Bash and curl available)

Run the smoke test

Run the nbs-test-api.sh script from the NEDSS-Infrastructure repository. See the README in that folder for usage instructions and current script status.

Next steps

After performing a successful smoke test, continue to Web UI smoke test for NBS interface and search.