The DeepAffex Cloud API is implemented as a connected mesh of distributed AWS clusters, each of which is hosted within a specific geographic region of the globe. To know more about different regions, please refer to the Regions and Clusters page in our Developer Guide.
While we will always strive to keep the information below in sync with our
Developer Guide, in case there are any conflicts, the Developer Guide should be
considered the source of truth.
A history of measurements results may be available on the DeepAffex Cloud if your legal agreement with NuraLogix allows saving results. Results, if saved in the DeepAffex Cloud, will be stored in the cluster-name encoded in the authorization Token. This is the Token that your backend server obtains by calling the Organization.RegisterLicense endpoint. This implies:
Default (no region locking): If your backend server obtains the authorization Token using the default DeepAffex Cloud API URL (https://api.deepaffex.ai), then the results will be stored in the cluster that was selected by the geo-routing rules defined in our Developer Guide.
Region Locking: If you want to store the results in a specific region, your server must obtain the authorization Token using the DeepAffex cluster-specific API URL of that region. Please refer to the direct regional URLs table below to know the different region-specific URLs.
If the optional apiUrl is not set in the
MeasurementEmbeddedAppOptions,
it will be automatically determined based on the backend token's region. This
effectively ties the frontend region to the backend token's region, which
should be suitable for most use cases.
If the optional apiUrl is explicitly set in the
MeasurementEmbeddedAppOptions,
the frontend will communicate with that URL, regardless of the backend token's
region. In this case, it is the implementor's responsibility to ensure
compatibility and prevent potential issues. Results will always be stored
in the backend token's region. Data processing will occur in the frontend's
region, as determined by your implementation.
| Region | URL |
|---|---|
| North America (N. Virginia, USA) Short code: na-east |
https://api.na-east.deepaffex.ai |
| Europe (Frankfurt, Germany) Short code: eu-central |
https://api.eu-central.deepaffex.ai |
| South America (Sao Paulo, Brazil) Short code: sa-east |
https://api.sa-east.deepaffex.ai |
| Asia (Tokyo, Japan) Short code: as-east |
https://api.as-east.deepaffex.ai |
| Asia Pacific (Hong Kong, HK) Short code: as-hk |
https://api.as-hk.deepaffex.ai |