Sandbox environment

What is a sandbox environment

Our sandbox environment offers all the same endpoints as the production service, allowing integrators to perform full end-to-end testing, including the Noa Notes widget and Noa Notes Integration API.

The only difference is that AI transcription is disabled in the sandbox. You can still start a recording using a provided template, but it will return mock test data, enabling you to fully test your integration workflows.

Webhooks are also supported in the sandbox environment.

Request Access

You can contact our integration team at integrations@docplanner.com, and they will provide you with a client ID and secret, similar to your production credentials.

How to Perform an End-to-End Test

Once you have received your API credentials, you can begin testing using our Noa Notes Integration API.

To test the Noa Notes widget from your local or development environment, follow the steps below to avoid CORS issues.

---

⚙️ 1. Set Up the Widget Locally

1. Import the Noa Notes widget into your HTML page (running on localhost or a development/testing environment).
2. By default, the widget makes calls to the production environment, but this can be overridden by using a proxy.
3. You can point the widget to your local proxy server, which forwards requests to the sandbox environment (https://integration.notes.sandbox-europe.noa.ai/api/v1/), thus avoiding CORS issues.

---

🧩 Widget Setup Example

Add the apiUrl property to the widget initialization code as shown below:

window.NoaNotesWidgetLauncher.noaWidgetLauncher({
  sessionToken: 'your-session-token',
  sessionId: 'your-session-id',
  consumerId: 'your-consumer-id',
  expiresIn: 86399, // session expiration in seconds
  recorderUrl: 'https://integration.notes.sandbox-europe.noa.ai/recorder/your-token?language=en-US&version=1&redirectUrl=https%3A%2F%2Fintegration.notes.sandbox-europe.noa.ai%2F%23%2Fsession',
  summaryUrl: 'https://integration.notes.sandbox-europe.noa.ai/#/session/your-session-id?login-token=your-token',
  locale: 'es-ES', // or any supported locale
  containerSelector: '#widget-container', // optional
  apiUrl: 'http://localhost:8081/api', // custom proxy to sandbox API
  onStatusChange: (status) => {
    // optional callback for widget status changes
  }
});

Example of a mock response on the summary endpoint

{
    "sessionId": "0f0e023d-2a3a-42cd-9d64-9ed2eb2fbd16",
    "content": "{\"result\":{\"Reason for the Visit\":\"Mocked Reason for the Visit value\",\"Medical History\":\"Mocked Medical History value\",\"Physical Examination\":\"Mocked Physical Examination value\",\"Assessment\":\"Mocked Assessment value\",\"Plan\":\"Mocked Plan value\"}}",
    "isVerified": false,
    "createdAt": "2025-07-22T16:44:54.8215",
    "verifiedAt": null
}

Environments

We have prepared 3 environments that allow the usage of the API while keeping minimal response times due to the region differences.

Region	API base url
South America	https://integration.notes.sandbox-southamerica.noa.ai
Europe	https://integration.notes.sandbox-europe.noa.ai
North America	https://integration.notes.sandbox-northamerica.noa.ai