This Article Contains The Following Questions:
- Does Ordergroove have a fully API-based platform?
- Why do some of Ordergroove's APIs have an authorization header, whereas others do not?
- Should I read the API response status codes exclusively, or rely on the error message?
- What value should I set for API timeout intervals?
Q: Does Ordergroove have a fully API-based platform?
All subscription integration touchpoints — with the exception of Product catalog updates, which are uploaded in an offline feed via SFTP — are powered by our API.
Q: Why do some of Ordergroove’s APIs have an authorization header, whereas others have HMAC auth in the URL parameters or the request body?
Ordergroove’s older suite of APIs (those at api.ordergroove.com, as well as some at sc.ordergroove.com) do not have authorization headers, instead of passing in authentication in the body of the request, or via URL parameters in rare instances. Our newer APIs (those at restapi.ordergroove.com, and some at sc.ordergroove.com) have an HMAC auth header.
Q: Should I read the API response status codes exclusively, or rely on the error messages?
We recommend you build your retry logic based solely on the API status codes (400, 401, 403, etc.). The accompanying error messages are human-readable and subject to change and thus not appropriate for use in error handling. These messages can be logged and used for troubleshooting.
Q: What value should I set for API timeout intervals?
The Service Level Agreement for most of our APIs is 1 second, but we recommend a 3-second interval to be safe. Visit the API documentation for more detail about which API responses warrant a retry and which fail permanently.