Breaking Changes... API URLs for online tenants
In the worst-case scenario, an application may have hardcoded a tenant API URL as "https://online.superoffice.com/[Cust00000]/api/v1," which may currently be functional. However, we have consistently advised developers to use either the WebApi_Url or NetServer_Url, which are issued as claims in the OpenID Connect id_token. In light of upcoming infrastructure changes aimed at improving load balancing and performance, the API URLs for online tenants are becoming more dynamic. The plan is to remove the API URL claims from the id_token and now are recommending all applications use the state URL to retrieve a tenant's API URL. The state URL follows the format: https://[environment].superoffice.com/api/state/[Cust00000] Here, the "environment" parameter is set to either " sod ," " qaonline ," or " online ," representing development, stage, or production environment, respectively. The "Cust00000" parameter is the unique identifier for the tenant. How often should applications check the state URL for changes? API URLs will typically be invalided during the evening during maintenance, which is posted on status.superoffice.com, however it may also depend on how much traffic an API endpoint receives. For more information, please refer to the documentation available at: https://docs.superoffice.com/en/apps/tenant-status We plan to enable these changes in the SOD environment moving forward. This will allow you to test your applications' resiliency and ensure it continues to function and operate before pushing any required changes to production. We expect to roll out these changes to production by the end of June this year . Question and/or comments are welcome.
11. apr 2023 | 10.51 a.m.