Documentation produit Connect

Nexway Connect makes it possible to sell thousands of software products and video games in a digital store.

This document aims to provide a good understanding of the value of Nexway Connect and how to best use it to grow your online sales. Business owners and developers are the typical audience for this documentation.

Nexway Connect provides a standard interface for collecting product catalog data (Product Feed) and for managing purchase orders (REST API). Nexway manages the complexity of the business relationship with the Publisher and the End-user product fulfillment.

For more technical documentation, please refer to https://apidoc.nexway.store/docs/nx-connect-api-docs/docs/_main.md.

• Publisher
Company publishing software, video games, or providing digital services.

• Merchant
Company selling software or games to consumers (B2C) or to companies (B2B). A merchant can be a classic online store or any company that wants to offer and sell digital products (software, video games, and/or digital services) to its audience or customers (end-users).

• End-user
Person or entity purchasing a video game, a software product, or a digital service for their own use.

• Nexway Catalog
Very large catalog of products (software, video games, digital services) that merchants can sell via Nexway.

• Product feed
The subset of the Nexway product catalog that a Merchant wants to offer their customers (end-users).

• Order
An electronic document that gathers the information related to the purchase of a software product, video game, or digital service.

• Fulfillment
All the actions required to provide the customer access to the software or the games purchased (download link, activation or license code, etc.).

Through Nexway Connect, Nexway allows Merchants (resellers) to access a very large catalog of software and video games to add to their online business. Nexway provides a standard interface to collect product catalog data and to submit purchase orders.

Nexway manages the complexity of business relationship between the publisher and the end-user product fulfillment.

Thanks to this solution, you as a Merchant can add thousands of software products and games to your digital store.

A Digital content scenario can be split in 4 steps:

Use the credentials sent to you by the Nexway Customer Success team (via the email address cs.nexwayconnect@nexway.com) to connect to Cocoon (preproduction: Cocoon UAT; production: Cocoon Production) to define your product feeds. For each product feed, you can define:

Each feed format is named and allows you to define feed such format parameters as:

You can define your product list by using  product defines a segment of the Nexway Catalog using the filtering criteria below:

Once created, the product list activates the product feed, which you can test through the Cocoon interface.

The parameters provided via the URL are:

Note: For security reasons, the IP address used on your side to access the product feed needs to be registered with and authorized by Nexway.

Products in the Nexway Catalog are classified in categories and subcategories (for example, Software/Antivirus&Security, CoreGames/Arcade, etc.) and are offered in a predefined operating system. Both the categories and the operating system are constantly enriched. We recommend that you update the list of categories and the operating system on a regular basis.

The Nexway Catalog is updated every day at 5:30am CET at the latest. You should schedule the download, product feed, and update of your product catalog for after 5:30am CET.
Keep in mind that some products may be removed from the product feed for certain reasons (for example, end of lifetime, out of stock, etc.).

To optimize your business, we recommend displaying the following information to your customer:

For Core Games, you should also highlight:

For Software, you should also highlight:

The product feed provides information about the active promotion of a given product during a period.

Some products can be ordered before they are available for delivery. They are identified as such in the product feed and the order must be submitted to Nexway only when the product is available (after the end of the pre-order phase). It is up to you, the Merchant, to process the purchase when required and to send the order request to Nexway when the product is available for delivery (and thus no longer in the pre-order phase).

Note:

Nexway Connect supports three delivery modes:

In the case of Microsoft products, if the Download DVD option is available, this option must be proposed in the cart.

Most of the casual games are available for trial. In this case, the end-user can either:

Both the “buy and down” version and the “try and buy” version are the same product.

The end-user can choose between “play” or “buy” when starting the Casual Game:

A template example of such a URL: https://my.domain.com/my_cart.html?prodRef={_PRODUCT_REF}

Follow the instructions below to implement Ubisoft’s new SKA process, which uses a License Activation Portal (LAP).

Identification
You can use DRM data to identify Ubisoft products if you are using catalog version 2.4 or higher:

Note: To identify Ubisoft products when using earlier versions of the catalog, you must verify the following in the product feed API:

Fulfillment
Ubisoft products are activated via a License Activation Portal (LAP), a web interface through which your end-users connect using their Nexway order number and their email address. This means that you as a Nexway customer (Connect partner) must:

Through Nexway API you can access the following API services:

If you have any subscription products available, you can also use the following additional API services:

Nexway highly recommends checking your product stock before adding a product to the customer cart (getStockStatus API).
If no stock is available, the order is refused.

Optionally, you can get a list of products and options to be added to the cart in addition to the initial product selected (getCrossUpSell API).
Available options:

Leverage your own payment system to process the payment of the purchase by the end-user.

Once the payment has been accepted, you must submit an order to Nexway that provides the information about the product purchased (createOrder API).
Depending on the API return code, the order is accepted or not. A subscriptionID will also be returned if the product is a subscription product.

Note: The real end-user email is requested in the order submission. For security reasons, some publishers send the information to the end-user directly in order to deliver and unlock the product.

You must send to or share the following information with the end-user:

When canceling an order:

Subscription products allow you to renew a license or service with customer at the end of every license period. Renewal happens by default upon expiry, unless you tell Nexway to cancel the subscription.

If you have any subscription products available, you can access the following additional API services:

1. Check product stock (mandatory)
Nexway highly recommends checking product stock before you add a product to the customer cart (getStockStatus API).

In case no stock is available, the order is refused.

2. Propose cross-selling, upselling, and options for a selected product (optional)
Optionally, you can get a list of product and options to add to the cart along with the initial product selected (getCrossUpSell API).
The following options are available:

3. Process the payment on your system (mandatory)
Leverage your own payment system to process the end-user’s payment for their purchases.

4. Create the order (mandatory)
Once the payment has been accepted, you must submit the order to Nexway providing information about the product being purchased (createOrder API).
Depending on the API return code, the order is accepted or not. If accepted, a subscription ID is also returned.

Note: The real end-user email is requested in the order submission. For security reasons, some publishers send the information required to deliver and unlock the product directly to the end-user.

5. Share the delivery information with the end-user
Three types of information must be sent to or shared with the end-user:

Subscriptions will renew automatically upon expiry, unless cancellation is requested (see cancellation process below).

1. Process the payment on your system (mandatory)
Process the payment on your system before the expiration date.

2. Check that the subscription was created
Check the “Get Subscription Status” API on regular basis (we recommend doing so once every 4 hours) with our subscriptionID, as well as watching for an incremental change in the partner order number generation.
The partner order number is composed of your original partner order number (transmitted in step 1.4) and subscription generation, delimited with dash sign, for example:

3. Get delivery information
When you see a change in the generated number, use your partner order number to call the “Get order data” API to get the order delivery information (such as the license number and activation key).

4. Share the delivery information with the end-user

An end-user may wish to end (cancel) a subscription.

When cancelling a subscription through the « Cancel subscription » API:

You can monitor your business through our Cocoon interface and track your orders, turnover, and margin. Nexway delivers official reports about your business on a monthly basis.

Nexway provides a testing environment (staging environment) to allow you to develop and test your integration.
Once your implementation is ready to go live, you need to inform Nexway and we will check with you that the following test scenarios are correctly implemented:

Catalog management

Order management

Customer support

Note: The testing environment (staging) is reset every month (first Sunday of the month).

Documentation
Nexway provides additional documentation to help you implement the Connect solution:

In case you have questions about leveraging Nexway Connect and you don’t see an answer in the Connect documentation, the FAQs, or the {+}API Documentation, you can also contact Nexway directly. Your feedback about our documentation is greatly appreciated.

Support
Technical issues and implementation
Contact the Nexway customer success team at cs.nexwayconnect@nexway.com

Orders and deliverables
Use your dedicated email (sent to you with your credentials) and provide such information as:

Day-to-day content
For all information about releases, promotions, missing products, and so on, get in touch with content-games@nexway.com

Table of Contents

Product Feed

How do I set the catalog language in Cocoon?
There are two language types in the catalogue: the master language and the description language.
The best configuration for the feed is:

What kind of link do you get with « getDownloadInfo »?
Only direct URL information is provided by getDownloadInfo (no information in the case of DownloadManager).

Which IPs can be whitelisted?
We whitelist only fixed IP addresses (no domain names nor dynamic IPs).

Why are all my previously-defined product feeds not listed anymore?
Every first Sunday of each month, the test environment is reset, which is why you can’t find your product feeds anymore.

What should I do if I see « Invalid » in the province field?
You will have to provide province (or state) data if the country is the US, CA, BR or AU (USA, Canada, Brazil, or Australia, respectively). You must enter the province or state data in ISO 3166-2 format: {+}https://en.wikipedia.org/wiki/ISO_3166-2+

What should I do if I receive an error 3011 (XML) message?
This sometimes happens in the test environment for the simple reason that we do not include all license files on the platform. You won’t see this error on the production site. Just try again with a different product.

What if I receive a « date is not valid » error?
You must enter the order date ousing the ISO 8601 format (ex : 2004-02-12T15:19:21+00:00).

What are the different prices available in the product feed?

Which price must be displayed on the website?
You are free to use the sale price or to set your own price with respect to your margin.

How do I add a new data column in my CSV product feed?
Available fields are present in the format feed configuration via Cocoon.

Order Issues

There’s no download link in the “createOrder” API return.
Some products don’t have download links but only serial numbers.

A direct download link is missing / Download Manager doesn’t retrieve all the files.
Contact customer support level 2.

There’s no serial number listed for the product.
Some products don’t have a serial number.

The download link is http://xxxxdigitallockerxx/xxx and no serial number is displayed. What’s wrong?
Not an issue: Microsoft products are delivered this way.