Best practices
Understand the best practices when integrating with the Digital River API.
Last updated
Digital River API reference
Understand the best practices when integrating with the Digital River API.
Last updated
When integrating with the Digital River API, you should know how to and .
You should understand how your account's determines the requests an API allows and the responses generated. The version also determines the structure of events generated by API requests.
You should always configure your to match the expected version of your code. In other words, when your code is deployed from test to production, the version on the keys should match the code version.
Digital River often makes to our API request and response content. As a result, we recommend your integration conform to the principle. Specifically, this means that you should:
Be aware that we can add new elements to responses at any time.
Build your code to extract only the attributes needed when reading responses and ignore everything else.
Avoid coding with a specific order of fields in mind.
IDs are alphanumeric strings that potentially contain special characters and have variable lengths.
Expect changes to the length and value of error messages and other strings that don't represent an enumeration, type, or code.
Anticipate the addition of new optional request and query parameters.
For HTTP GET requests, we encourage making concurrent calls.
Avoid making changes to the same resource in multiple calls. Instead, bundle changes in a single call.
Avoid making concurrent mutation calls to the same resource.
The webhook endpoint must be able to handle concurrent webhook callback requests.
You may receive multiple duplicate webhook events. So, be sure you can process the delivery of duplicate events.
Your webhook endpoint must respond to callback requests promptly. A response time greater than 3000 milliseconds is considered a timeout. We expect you to immediately acknowledge the callback request by sending an appropriate HTTP 2XX response code. Once you acknowledge the callback, you can asynchronously process the webhook event on your end.
You should know how the Digital River API represents and ensure you properly format them in your requests.
When creating a checkout, invoice, or order, you should to improve fraud detection.
To make call debugging easier, you should use specific .
Attempt to minimize HTTP 400 Bad Request and 409 Conflict by adding appropriate validation checks before a request is submitted.
Our help ensure that the Digital River APIs are efficient, secure, and reliable. So, when building your integration, you should be aware of and then implement automatic retry mechanisms that . To avoid hitting the request ceiling entirely, follow our rate-limiting .
You can use the liveMode flag contained in API responses to determine whether you're pointing to the correct .
When using , check the to ensure callback requests have not been tampered with.