The Digital River API speaks exclusively in JSON. So in order to ensure the API accepts and processes your requests, always set the content-type header to
The API key you use to authenticate a request determines whether the request is handled in live mode or test mode. Use the Digital River API in test mode when you don't want to interact with financial institutions.
All Digital River API requests are sent to
For more information on how Digital River ensures high availability and performance, see our Service Level Agreement.
This guide shows you how to start making Digital River API requests. By the end, you'll know how to set up a Dashboard account, obtain your API keys, and perform a test request.
Before you can start making Digital River API requests, you'll need to use the Request Demo form to sign up for a Dashboard account. In the Tell Us More field, request your API keys. In one to two days, when your account is activated, you'll receive an invitation by email.
Once you successfully sign in to Dashboard, you'll be able to access your account's API keys. Your account is provided with four keys in total: a public and secret API Key for sending requests in both test and live modes. In Dashboard, toggle between Test Data and Live Data to view your public keys and click Reveal test token or Reveal token to unmask your secret key.
Digital River uses these keys to authenticate your API requests. The API key you use to authenticate the request determines whether the request is live mode or test mode. If you forget to provide your key or use one that is incorrect or outdated, the API returns an error.
After you have access to your API keys, you'll want to perform a test request. The following steps demonstrate how to do this:
Go to the Digital River API Postman Collection page on GitHub.
To install the Digital River API Postman Collection, click the Run in Postman button and select Postman for Windows.
Click the icon on the Digital River Collection you just imported and select Edit.
In the Edit Collection window, select the Variables tab.
For the secretKey variable, paste your secret test key into the Initial Value and Current Value fields.
Back in the collection, expand the Create a Client-fulfilled SKU folder and open the Create a physical sku request.
In the body of the request, use the
id object to specify a unique identifier for the SKU and click Send.
A successful response contains an
id value that matches the one in the request body.
Now that you've successfully performed a simple test request, you're ready to take a deeper dive into the Digital River API.