Establishing an API "health check" to Zuora APIs

[scottb]

Question or Problem Statement:
We’re interested in establishing some sort of API “health check” to verify Zuora’s API availability and general performance – does Zuora have any recommendations or guidelines for something like this?

[scottb · Accepted solution]

Solution:

Yes, I can offer the following suggestions.

Health check APIs should be generally very lightweight calls made at a reasonable cadence as to not abnormally interfere with your own (or other) tenant traffic. 

SOAP API: Recommend using login() API

REST API: Recommend connections API

The advantage to using connection/login is that it doesn’t impact your concurrency thread availability as it’s “free” in terms of this rate limit.  For the timing of your testing loop, please try to keep your rate reasonable - perhaps somewhere between 15-60 second intervals.

See also

http://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/E_SOAP_API_Calls/login_call

http://knowledgecenter.zuora.com/DC_Developers/C_REST_API/B_REST_API_reference/Connections

https://www.zuora.com/developer/api-reference/#tag/Connections

https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits