Sonde Health API Platform Documentation
Account
Overview
Creating an Account:
You can create your account on the Sonde Portal to access the Test key and the Prod key. To receive the Sonde Portal signup link please send an email to “support@sondehealth.com”.
While developing your App use the Test key and once you are ready for your App release use the Live key.
Signup with your official e-mail id. Once you Signup, you are eligible for the two keys:
test key for test data
and live key for live data
Check the API Keys section on the Dashboard.
Using the test key you can perform a limited number of health checks, If you want to increase the test health checks limit, please contact support@sondehealth.com with your company address.
On Signup live key is disabled. If you want to apply for an enterprise plan, please
Once you subscribe to the enterprise plan, you would be able to view the live key. You can still continue to use your test key for development purposes.
Enterprise plan pricing is based on the license fees and terms and conditions set up by Sonde’s sales team.
| Type of plan and function | How to get the key | Pricing |
---|---|---|---|
test key (for test data) | Test Plan for application development, proof of concept | Login to Sonde Portal and get the test keys. | A limited number of health checks available for testing. If additional health checks are needed during development, contact support@sondehealth.com. |
live key (for live data) | Enterprise plan for live production | Contact support@sondehealth.com with your company name, address, contact person, contact number, and a brief summary of your application. | Enterprise plan pricing is based on the license fees and terms and conditions set up by Sonde’s sales team. |
PII & PHI storage region for test data and live data
Sonde API Platform supports three regions to store PII and PHI data. Based on the content of the audio sample, the audio file may be considered Personal Identifiable Information (PII).
These storage regions which Sonde currently stores are:
Northern Virginia (Country Code US)
Northern Virginia to store the United States of America user’s data.Frankfurt (Country Code DE)
Frankfurt to store European countries' user’s data.Mumbai (Country Code IN)
Mumbai to store Indian user’s data.
The application will need to pass the correct country code while requesting a signed URL from StorageService to upload the user's audio file in the appropriate storage region. For more detail on API and their usage please refer to the use-case document Respiratory Symptoms Risk (variant: v2)
You can see enabled storage regions for your account in Profile & Settings section on Sonde Portal.
By default, the US region is enabled for data storage. To enable other regions, the following are the options:
Option 1: Subscribe to an enterprise plan to enable edit functionality in Profile & Settings section. You can edit and select IN and DE regions. This selection is applied for the test as well as live data storage.
Option 2: Open a support ticket (support@sondehealth.com) to enable the other region. In the support ticket please mention your company name, address, and email you have used to create an account with Sonde.
Sonde Health