Digital rights
Understand how Digital Rights work.
Digital Rights refer to entitlements provided to consumers, such as serial numbers, unlock codes, or download URLs, necessary to access or activate digital products or services. Consumers receive these rights by email after the purchased order is fulfilled.
Unsuccessful response or communication issues
When you receive an unsuccessful response or experience communication issues (such as failed transports), the shopping process behaves as follows:
Retry policy
The retry policy is a critical component of our system's reliability strategy, ensuring that temporary issues do not prevent the successful completion of transactions. This policy defines how the system handles unsuccessful responses, outlines the intervals and duration for automatic retries, and stipulates conditions under which the system ceases retry attempts and handles the order accordingly. This mechanism helps to maintain user satisfaction by not imposing charges until the transaction is successful and digital rights are delivered.
The retry policy ensures that if an unsuccessful response or communication issue occurs, the system attempts to resend the request periodically. Here’s a breakdown of how the retry policy works:
Auto retries: If the
<isAutoRetriable>element istrue, the system retries the request every hour.Retry duration: The system continues to retry for up to 21 days.
Order handling: If no successful response is received after 21 days, the order is removed from the system.
Consumer charges: The consumer is not charged until they successfully receive their digital rights, such as serial numbers or unlock codes.
Exception handling
Exception handling is the process of responding to the occurrence of exceptional conditions (e.g., an error during execution) that disrupt the normal flow of a program. This involves detecting errors, reporting them, and taking corrective actions to ensure the system functions correctly. Types of exceptions include:
Timeout Exceptions: Occur when a request times out.
Network Errors: Issues related to loss of connectivity.
Invalid Data: This happens when the data received is not as expected.
Charging policy
The consumer is not charged during this period until you fulfill their order and they obtain the necessary digital rights (such as serial numbers or unlock codes). If the process is not completed within 21 days, the order is cancelled, and the consumer will not incur any charges.
Integration exception
An integration exception refers to an error during the system integration process where different software components or systems fail to communicate or transfer data correctly. This can involve issues such as unsuccessful digital rights responses and missing or invalid elements in the data exchange. The integration exceptions are recorded and displayed on the globalCommerce Integration Exception screen, which provides detailed information, including error messages and corrective actions.
Handling failed digital rights
When a digital rights request fails, the corresponding line item enters a "failed digital rights" state and appearson the globalCommerce Integration Exception screen. Here are the steps to handle this scenario:
Review the error details: Examine the details provided in the
<returnMessage>element on the Integration Exception screen.Assess the
<isAutoRetriable>flag:If
<isAutoRetriable>isfalse, ensure the<returnCode>is non-zero and use the<returnMessage>to understand and rectify the issue.If the
<key>element is missing or empty, Digital River will attempt to resolve the issue using the information in<returnCode>,<isAutoRetriable>, and<returnMessage>, then retry the request.
Resubmit the line item: After fixing the identified issue, resubmit the line item through the Integration Exception screen for a new attempt at obtaining the digital rights.
Response details for an unsuccessful scenario
In a successful scenario such as this, the system ignores <returnCode>, <isAutoRetryiable>, and <returnMessage> elements. These elements come into play in an unsuccessful scenario.
Note that the <item> element is unbounded. That means you can send multiple keys in response (in response to the <quantity> element in this <getKeyRequest>).
A successful Digital Rights request results in a response that contains a non-null, non-empty <key> element.
Response details for a successful scenario
When a shopper buys a product that has Digital rights, they get a key (serial number or unlock code) that they can use to access the product.
You can create and associate keys with products to deliver and manage Digital Rights. You can create as many keys as needed to satisfy your Digital Rights requirements.
Digital Rights is an outbound event.
Key Request
Key Revocation
The types of custom integrations for Digital Rights are as follows:
Digital Rights refer to the rights or permissions granted to a shopper by the publisher or manufacturer to use or access a software application, game, system, etc. Digital Rights protect the sale and distribution of copyrighted works. Use Digital Rights to enable and manage the serial numbers and unlock codes that control access to software and other digital products.
Digital Rights refer to the rights or permissions granted to a shopper by the publisher or manufacturer to use or access a software application, game, system, etc. Digital Rights protect the sale and distribution of copyrighted works. Use Digital Rights to enable and manage the serial numbers and unlock codes that control access to software and other digital products.
The types of custom integrations for Digital Rights are as follows:
Key Request
Key Revocation
Digital Rights is an outbound event.
You can create and associate keys with products to deliver and manage Digital Rights. You can create as many keys as needed to satisfy your Digital Rights requirements.
When a shopper buys a product that has Digital rights, they get a key (serial number or unlock code) that they can use to access the product.
Response details for a successful scenario
A successful Digital Rights request results in a response that contains a non-null, non-empty <key> element.
Note that the <item> element is unbounded. That means you can send multiple keys in response (in response to the <quantity> element in this <getKeyRequest>).
In a successful scenario such as this, the system ignores <returnCode>, <isAutoRetryiable>, and <returnMessage> elements. These elements come into play in an unsuccessful scenario.
Response details for an unsuccessful scenario
An unsuccessful response occurs when the <key> element is missing or empty. In this situation, Digital River will try to fix the issue causing the non-successful response by using the <returnCode>, <isAutoRetriable>, and <returnMessage> elements and try again.
If the <isAutoRetriable> flag is false, the <returnCode> element must contain a non-0 response. Also, the <returnMessage> element should explain what the value in <returnCode> means, what is wrong with the request, and, if possible, how to fix it.
When an unsuccessful Digital Rights response occurs:
The consumer is not charged for the line item until receiving a serial number, unlock code, or download URL.
The line item goes into a "failed digital rights" state, and when this happens, it appears on the globalCommerce Integration Exception screen.
Using the details provided in the
<returnMessage>element, you can use the globalCommerce Integration Exception screen to fix the issue and resubmit the line item.
If the <isAutoRetriable> element is true, Digital River automatically retries the request every hour for 21 days. If there is no action after 21 days, the system "forgets" the order.
When you receive an unsuccessful response or experience communication issues (such as failed transports), the shopping process behaves as follows:
The consumer does not receive the Digital Right (serial number, unlock code, or download URL). Instead, the consumer gets instructions to wait for an email containing the Digital Right.
The consumer will receive Digital Right by email when the order is fulfilled.
The consumer is charged until the Digital Right is fulfilled.
Key request
The Digital Rights process is a request/response-based process for retrieving external digital rights. When a purchase occurs, the process requests a serial number or an unlock code. A key request integration sends a request for a key (serial number or unlock code) when a shopper purchases a product set up to use the integration.
Notification—Global Commerce generates a Get Key Request and sends the request to your endpoint.
Required Response to Notification—Your endpoint must synchronously respond with a Get Key Response.
Schemas
Schemas define the structure and format of the data exchanged between systems. They ensure that data is consistently formatted and interpreted correctly by both the requestor and the responder. In the Digital Rights process, schemas provide the specific structure for the key request and response messages, including required and optional fields to ensure smooth integration and communication between systems.
| Version | Schema Component Table | Raw Schema | Sample XML |
|---|---|---|---|
10 (Current) | |||
9 | |||
8 |
Last updated
