Commerce API

Learn how to use Digital River's commerce platform to run your online store, receive payments, and ship orders.

Welcome to the Digital River Commerce API documentation. This API equips developers with robust tools for integrating our advanced payment, fraud prevention, and compliance services into their eCommerce platforms. With the Commerce API, effortlessly create products, manage carts, process orders, and more, ensuring your business is secure and fully compliant with global regulations. Whether building from the ground up or enhancing your current system, our API streamlines your eCommerce operations, ensuring a smooth experience for you and your customers. Let's dive into how you can integrate these features into your platform.

Working with Digital River

Digital River provides more than global payment and fraud solutions; we also serve as the merchant of record for your products, taking on the risk of sales, managing taxes, and handling regulations on your behalf. To deliver these services effectively, we require some basic information. This information allows us to apply accurate taxes, process payments smoothly, conduct fraud screenings, and ensure compliance with local laws through our legal entities.

Getting started

Welcome to the first steps toward integrating the Digital River Commerce API into your eCommerce platform. Whether you are looking to improve the purchasing journey for your customers or streamline your backend operations, this guide navigates you through the initial setup process. By following our straightforward steps, you'll obtain the necessary API credentials, learn the basics of making API calls, and start leveraging our Shopper and Admin APIs. Let's begin this exciting journey to enhance your online storefront with Digital River's comprehensive commerce solutions.

Shopper APIs

The Shopper APIs enhance the front-end user experience. They enable functionalities such as:

• Creating and managing a storefront

• Handling shopper workflows

• Operating the store

• Displaying products

To use the Shopper APIs, you'll need:

• An API key with permission to access these APIs

• Either an anonymous or authenticated token for making shopper requests

Admin APIs

The Admin APIs focus on backend administrative operations, allowing for:

• Management of refunds

• Subscriptions handling

• Site management

• Product management

To use the Admin APIs, requirements include:

• An API key specifically granted permission for Admin API access

It is important to note that obtaining an API key that provides access to both API collections is possible, enabling comprehensive control over shopper-facing and administrative functionalities of your eCommerce platform.

Step 1: Obtain API credentials

1. Start the site creation process: Use the Request Demo form on the Digital River website to express your interest and obtain your API keys.

2. Specify your needs:

   • If you're looking for trial access, mention that you need a "test API key for the Commerce API suite."

   • If you need full access to the Shopper and Admin API collections, specify that your "keys need permission to use both the Shopper APIs and the Admin APIs."

3. Wait for Digital River to contact you: After submitting your request, Digital River will reach out with further information, including instructions on accessing your API keys.

4. API key usage: Once you have your API keys, use them to authenticate your API requests. Remember, the API key dictates whether you're operating in live or test mode.

Note: Always use the correct and current API keys to avoid errors.

Step 2: Perform a test request

Perform a Test Request

After obtaining your API keys, follow these steps to perform test requests:

1. Install Postman: Ensure you have Postman installed on your computer to proceed further.

2. Import the Commerce API Postman Collection:

   • Navigate to the Commerce API Postman Collection page on GitHub.

   • Follow the instructions provided there to install the API demo collection into Postman.

3. Configure the collection:

   • In Postman, find the imported Commerce API Quick Start collection.

   • Click the View more actions () icon on the collection and select Edit.
   • Switch to the Variables tab in the Edit Collection window.

4. Set up variables:

   • Fill in the following details for each variable:

     • apiDomain: Use api.digitalriver.com for the production environment or api-cteext.digitalriver.com for the test environment (CTE) in the Current Value field.

     • publicApiKey: Enter the public API key provided by Digital River in the Initial Value and Current Value field.

     • drjsApiKey: Enter the DigitalRiver.js key provided by Digital River in the Initial Value and Current Value field.

     • confidentialApiKey: Enter the confidential API key provided by Digital River in the Initial Value and Current Value fields.

     • confidentialSecret: Enter the confidential secret provided by Digital River in the Initial Value and Current Value field.

5. Test requests:

   • You can run each request individually by selecting it and hitting the send button or using the collection runner to execute all requests sequentially for comprehensive testing. See the Error codes section if you get an error.

Now that you've successfully performed a series of simple test requests, you dive deeper into the Commerce API.

Contact us

If you have questions or concerns or want to move forward with Digital River, visit our website at https://www.digitalriver.com/ and click Talk To Sales.