Learn more about the standards related to logging requests, responses, and errors.
The checklist items and standards in this section cover logging requests, responses, and errors. This helps ensure you can provide adequate technical details when seeking support from Digital River or upstream platforms. We also cover the types of error messages you should and should not display to your customers.
Click any checklist item to be provided more detail on how to meet the integration standard.
These integration standards relate to error handling and logging:
It's good practice, especially during the development and testing phases, to log all of your platform's successful and failed API calls. When you're making a large number of calls, however, this can quickly become overwhelming.
You may decide you want to add a toggle to your tool that allows you to enable or disable debug logging. This would then permit each client site that implements the tool to turn off logging when necessary.
All the Digital River APIs respond with standardized HTTP status codes. In case they are needed for support purposes, your platform should log the error responses in the
5xxrange. We recommend you do this regardless of whether you have a setting to disable bug logging. Your error logs should include a timestamp, HTTP code, the URL of the API, and the API request and response payloads.
When customers encounter errors during the checkout process, or any time while interacting with your tool, you should provide them simple, but meaningful messages. You should not, however, share specific error codes. Doing so increases the probability that attempts to commit fraud and other malicious attacks will eventually succeed.