Configure the Merchant Center custom application

Learn how to configure the Merchant Center custom application.

Configure the custom application

Once the Merchant Center custom application has been deployed, you need to configure it by adding it to your commercetools project.

To start the configuration process do the following:

• Configure standard Digital River keys Set your API keys

• Configure webhooks and webhook events

• Create a webhook secret and warehouse address(es).

The initial configuration steps just listed are done in the Digital River dashboard.

Configure standard Digital River keys

Your Digital River Dashboard account provides separate keys for testing and for running live transactions. You can use these keys when sending API requests in either test or live mode. Resources in one mode cannot change resources in another mode.

You can apply a different API version to each individual key, or you can update the version on all keys in the current mode (test or live).

Configure standard keys in the Digital River dashboard. The API version must be 2021-03-23

Configure webhooks and webhook events

To keep commercetools synchronized with data in Digital River, a webhook is required with the following configuration values:

Property	Value	Note
API version	2021-12-13
Transport type	HTTP	Only HTTP transport type is supported
Endpoint URL	{baseUrl}/api/v1/webhooks/digitalriver	The baseUrl will be defined by where you deploy the connector. You should front the connector with HTTPS in production
Username		Not required but you may enable basic auth on the server fronting the connector
Password		Not required but you may enable basic auth on the server fronting the connector

Once the webhook is configured, enable the following webhook events:

Event	Purpose
customer.source.created	Adds data to customer.custom.fields.drSources when a payment method is saved
customer.source.deleted	Removes data from customer.custom.fields.drSources when a payment method is deleted
order.blocked	Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState
order.cancelled	Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState
order.charge.cancel.complete	Creates/Updates CancelAuthorization transactions and payment.paymentStatus.interfaceCode
order.charge.cancel.failed	Creates/Updates CancelAuthorization transactions and payment.paymentStatus.interfaceCode
order.charge.capture.complete	Creates/Updates Charge transactions and payment.paymentStatus.interfaceCode
order.charge.capture.failed	Creates/Updates Charge transactions and payment.paymentStatus.interfaceCode
order.charge.capture.pending	Creates/Updates Charge transactions and payment.paymentStatus.interfaceCode
order.complete	Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState
order.created	Updates cart shipping and tax info, creates cart from order
order.accepted	Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState. Adds authorize transaction if required data was not in order.created event
order.credit_memo.created	Adds URL to order.custom.fields.drCreditMemoUrls
order.fulfilled	Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState
order.invoice.created	Adds URL to order.custom.fields.drInvoiceUrls.
order.review_closed	Updates order.custom.fields.drOrderState and order.custom.fields.drFraudState
refund.complete	Creates/Updates Refund transaction and payment.paymentStatus.interfaceCode
refund.failed	Creates/Updates Refund transaction and payment.paymentStatus.interfaceCode
refund.pending	Creates/Updates Refund transaction and payment.paymentStatus.interfaceCode

Create a webhook secret

This section describes how to create a webhook secret.

Obtain the Digital River secret key

Once you have configured the webhook and enabled webhook events, you can reveal and obtain the secret (confidential) key in the Digital River dashboard. This key is used when configuring the demo customer application (described later).

Follow the steps provided in the Configuring Custom Applications section of the commercetools documentation (link provided).

In step 6, use the following values:

Property	Value
Name	Digital River
Application URL	The value you used for PRODUCTION_URL in Merchant-Center-Deployment
Application entry point URI path	digital-river
Oauth scopes for ViewDigitalRiver	view_key_value_documents
Oauth scopes for ManageDigitalRiver	manage_key_value_documents
Main menu - Default link label	Digital River
Main menu - Link permissions	ManageDigitalRiver
Main menu - Link icon	settings

In the Submenu, add 3 links with these values

Link to	Default link label	Link permissions
api-keys	API Keys	ManageDigitalRiver
warehouse	Warehouses	ManageDigitalRiver
catalog-sync	Catalog Sync	ManageDigitalRiver

After registering the application you will have access to the application id you need to deploy the application.

Now follow the Installing a Custom Applications steps. When assigning team permissions enable View all: Digital River and View and edit all: Digital River to give users access.

After completing the steps you should see the Digital River application at the bottom of the left navigation in the Merchant Center.