Skip to main content

API Domain

When you create an application in the Console, you can select either the China (Beijing) Data Center or the Singapore Data Center based on your business environment (refer to Data Center). Different data centers use independent server API addresses. When calling the Server API, the application server must use the Server API address corresponding to the data center; otherwise, the API request will not return the correct result.

Important

  • To avoid issues such as App Secret leakage, all Server API interfaces must be called through the App Server. Do not call the Server API directly from the client.
  • When calling the Server API, it is recommended not to use the KeepAlive method. If there are special circumstances requiring the use of KeepAlive, it is recommended that the idle timeout for each long connection be less than 55 seconds, and the reuse count be less than 80 times. It is recommended to switch to a new connection when a connection has been idle for 55 seconds or reused 80 times. Long-term use of the same connection may lead to API load balancing failure, affecting the fault tolerance strategy.

Server API Domain​

API Addresses for China (Beijing) Data Center​

The IM Service provides two independent server API addresses for applications in the China (Beijing) Data Center:

  • api.rong-api.com
  • api-b.rong-api.com
tip

It is recommended that you implement automatic switching logic between the default domain and the backup domain to avoid access to the IM server API being blocked due to issues with a single CDN provider, thereby affecting your business.

The following Server API domains are outdated and can still be used, but are no longer recommended:

  • api.cn.ronghub.com
  • api-cn.ronghub.com
  • api2-cn.ronghub.com
  • ai-sg.ronghub.com (Translation Service)

API Addresses for Global Data Center​

For applications in the global data center, please use the corresponding server API addresses:

  • Singapore: api.sg-light-api.com (Primary), api-b.sg-light-api.com (Backup)
  • Singapore (Enterprise): api.sg-b-light-api.com (Primary), api-b.sg-b-light-api.com (Backup)
  • North America: api.us-light-api.com (Primary), api-b.us-light-api.com (Backup)
  • Saudi Arabia: api.sau-light-api.com (Primary), api-b.sau-light-api.com (Backup)

Important

Applications using the global data center also need to configure the data center address for the client SDK. For details, refer to the knowledge base document Global Data Center Usage Guide.

Best Practices for Domain Switching​

tip

Domain switching is only applicable to applications using the China (Beijing) Data Center.

When using a single server API address, there may be delays in accessing the Server API due to issues with the CDN provider, which could impact your business. For applications using the China (Beijing) Data Center, we provide two domains. It is recommended that developers implement switching logic between the default domain and the backup domain.

  1. When calling the IM server API, developers need to save the currently used domain.

  2. If a timeout or unavailability occurs during the call, immediately switch to the other backup domain for access, and update the currently used domain. Repeat this process to avoid impacting your business.

Last updated on