Getting started

Learn the basics of the Commerce API, how to obtain your credentials, and start making requests.
This guide shows you how to start making Commerce API requests. By the end, you'll know how to obtain your API keys, import the Postman collection, and run each request. This collection provides the basic requests necessary to submit a simple order through the Commerce API.

Step 1: Obtain API credentials

Before you start sending Commerce API requests, use the Request Demo form to request your API keys or contact your account manager.
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 live mode or test mode. If you forget to provide your key or use an incorrect or outdated key, the API returns an error.

Step 2: Perform a test request

After you obtain your API keys, you'll want to perform some test requests. The following steps demonstrate how to do this:
Make sure you install Postman before proceeding.
  1. 1.
    Go to the Commerce API Postman Collection page on GitHub.
  2. 2.
    To install the Commerce API Postman Collection, click the Run in Postman button and select Postman for Windows.
  3. 3.
    Click the
    icon on the Commerce API Quick Start collection you just imported and select Edit.
  4. 4.
    In the Edit Collection window, select Variables.
  5. 5.
    Using the Current Value fields, enter the appropriate API key for each variable, and click Update.
  6. 6.
    Run each request individually or use the collection runner to run each one sequentially.
Now that you've successfully performed a series of simple test requests, you're ready to take a deeper dive into the Commerce API.