Getting started

Learn the basics of the Digital River API, how to obtain your credentials and start making requests.

Basic information

The Digital River API is a RESTful API. That means we designed the API to allow you to create, read, update, and delete objects with thePOST, GET, PUT and DELETE HTTP methods.

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 application/json .

The API key you use to authenticate a request determines whether the request is handled in production 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.

Quick start guide

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.

Step 1: Obtain API credentials

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 confidential API Key for sending requests in both test and production modes. In Dashboard, toggle between Test and Production to view your public keys and click Reveal test token or Reveal token to unmask your confidential 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 in production mode or test mode. If you forget to provide your key or use one that is incorrect or outdated, the API returns an error.

Step 2: Perform a test request

After you have access to your API keys, you'll want to perform a test request. The following steps demonstrate how to do this:

Make sure you install Postman before proceeding.

  1. Go to the Digital River API Postman Collection page on GitHub.

  2. To install the Digital River API Postman Collection, click the Run in Postman button and select Postman for Windows.

  3. Click the icon on the Digital River Collection you just imported and select Edit.

  4. In the Edit Collection window, select the Variables tab.

  5. For the secretKey variable, paste your confidential test key into the Initial Value and Current Value fields.

  6. Click Update.

  7. Back in the collection, expand the Create a Client-fulfilled SKU folder and open the Create a physical sku request.

  8. 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.