Use the provided DeepAffex™ license key to register the license by calling the
Organizations.RegisterLicenseendpoint. A pair of tokens (a Device Token and a One-Time Refresh Token) is returned. To learn more about tokens, please refer to the authentication chapter in our developer guide.
Store tokens safely in the device's secure storage. Tokens must be used for any subsequent DeepAffex™ API calls.
To ensure that a token is valid before making a DeepAffex™ Cloud API call, you can call the
General.VerifyTokenendpoint which returns the token's status.
Your application should call
Auths.Renewendpoint if the Device Token has expired. If the Refresh Token has also expired or was not available, your application may need to call the
Organizations.RegisterLicenseendpoint again to obtain a fresh pair of Device and Refresh Tokens
ActiveLicense field in the
General.VerifyToken response is
please contact NuraLogix™ to renew your DeepAffex license. Your application is
responsible to handle this failure case gracefully.
- Upon your app's initial launch, prompt the user to complete the measurement questionnaire. For further details on questionnaires, please refer to the Measurement Questionnaire Section in our developer's guide. This information will enhance the accuracy of future measurements, some of which will depend on these data.
Your application needs to request camera permission before taking measurements. Anura™ Core SDK will not work without access to the camera, and your application needs to handle the case when the user denies the camera permission.
You can customize the look and feel of the measurement UI though
MeasurementUIConfiguration. To learn more on how to customize the measurement UI, please refer to Measurement UI Customization iOS and Measurement UI Customization Android.
To obtain measurement results in real-time, your application can set up a WebSocket connection and use the Measurements.SubscribeResults endpoint. After the measurement is complete and all results are received, your app may disconnect the WebSocket connection.
Before your app can start sending measurement payloads to obtain results, it must first create a measurement using the Measurement.Create endpoint. The endpoint will return a measurement ID, which is used to refer to the measurement in subsequent API calls.
After the measurement starts, each extracted payload needs to be sent to DeepAffex™ Cloud in sequence. For information about this interface, please refer to the Measurement.AddData endpoint.
If your application is subscribed to results over WebSocket, the results can be obtained from the
MeasurementResultsobject. Your application can then display these results on the measurement screen (e.g. heart rate), and on a separate results screen after the measurement is complete. For more information on how to interpret the results, please refer to the DFX Points Reference.