An integration is something that connects one system (such as Global Commerce) with another system so that the two can transmit or share data between each other.
The Custom Integration feature allows you to create an integration between Global Commerce and a digital rights management (DRM) system. DRM systems can store, deliver, and/or manage serial numbers and unlock codes for products.
Custom integrations are different than other integrations you might have on your store because custom integrations are created and managed by you within the Command Console. Other types of integrations rely on Digital River to do some work and set up for the integration to function as expected. Custom integrations can be created and managed solely by you, the client.
Note: Custom Integrations is only available if your store is using the Self Service (Rivulet) template. To find out what template your store uses, contact your Store Operations Team.
Before You Create a Custom Integration
Before you create and use a custom integration you must make sure that the system you want to handle the integration requests from Global Commerce is set up and tested to ensure it is working correctly. When you create an integration you enter the URL of the system where the request should be sent, so if the system isn't functioning the custom integration will not work.
We also recommend that you familiarize yourself with the XML schema for key requests and key revocations that can be found in the Integration Services Guide. The schema will help you determine what data your DRM system will need to send and how those requests should be structured. To gain access to the Integration Services Guide, contact your Store Operations Team.
Type of Integrations You Can Create
There are two types of custom integrations you can create and then associate with products to deliver and manage digital rights. You can create as many of these integrations as needed to satisfy your digital rights needs. To learn how to create a custom integration, see Creating Custom Integrations.
- Key Request – Requests a serial number or unlock code when a purchase is made.
- Key Revocation – Revokes a key that has already been delivered to the shopper. To learn how to set up what triggers a key to be revoked, see Configuring When Key Revocations Occur.
Using Your Custom Integrations
Custom integrations are created to deliver and manage digital rights for products. There are two different types of integrations you can create (key requests and key revocations) and so two different ways those integrations are used on your store.
Note: By default, when you create a custom integration it is enabled (made active) for your store. You can disable any custom integrations you no longer use or want to temporarily stop using. To learn how to enable or disable custom integrations, see Enabling and Disabling Custom Integrations.
Using Key Requests with Your Products
Once you create (and enable) a key request custom integration, you can then use that custom integration to deliver keys for products purchased on your site. You do not have to use the key request custom integration for all your products that use digital rights; you can use the custom integration on as many or as few as you need.
Your key request custom integrations can only be used for a product when the digital rights Generation Method is set to External. Once this is set you will then see the custom integration(s) you have created in a list of available integrations.
The picture below shows where in the Configure Digital Rights Management window you will see your custom integrations (you see the same on both the Serial Numbers and Unlock Codes tabs).
Configuring when Key Revocations Occur
Once you create a key revocation custom integration you can configure when that integration should be triggered and used (see Configuring When Key Revocations Occur).
A key revocation integration revokes a key that has already been distributed for a product and can be revoked for one or more of the following reasons:
- Product or order is refunded.
- Product or order is disputed – A dispute happens when a shopper calls the issuer of the payment (credit card company, payment institution, etc.) and disputes the charge on their account. Disputes may occur because the shopper didn't authorize the charge, or because the shopper cannot contact the seller to get a refund when they have a problem with the order or product.
- Settlement is declined – Some payment methods do an "immediate" authorization of the payment that doesn't actually collect the payment or verify the payment can be made. In these cases, authorization may be gained and fulfillment will begin (including fulfillment of the digital rights) before payment is collected. If the issuer then denies the payment, the settlement for the order will be declined and a revoke will be triggered.
- Order is marked as fraud.
Related Topics