What are the factors that may cause API failures?
Latency with connectivity, specially after device is coming back from an extended sleep mode or a device reboot, may be caused by services that may have not reached their ready state. The device hardware may also play a role as the Smart Operational Panel boots up faster than the device’s controller.
To mitigate possible issues with connectivity it is recommended that the application retry the API multiple times even if the requests fails or exceptions are thrown.
The steps to follow are:
- Retry API.
- Ensure NETWORK_CONNECTED: true.
Below are links with documentation resources that provide further details:
Recommendation of Retry When Using WebAPI
Common Information – Development Guide – 11. Recommendation of Retry When Using WebAPI
/doc/en/guide_web/090-11-0100.htm?ssdk_v3
Network Connection Notification
Smart Operational Panel – SDKService API – 17. Network Connection Notification
jp.co.ricoh.isdk.sdkservice.system.SystemManager.NETWORK_CONNECTED
/doc/en/javaapi/100-17-0100.htm?ssdk_v3
As an example this API may fail: (ensure retries and connection is established)
Network Basic Information
Common Information – Web API – 01. Network Basic Information
/rws/property/network
/doc/en/webapi/460-01-0231.htm?null