Set Up License Obtaining Through Your Web Service

A web service is a license generation method allowing you to fulfill orders by delivering products to customers electronically.

With this delivery method, a web service must be developed on your end. Upon request from our end, this web service will generate a license for a product and return it in response. We will send the received license to the customer by email.

Supported:

• Data transfer method: POST or GET
• License format: text
  If a license is a file, it must be stored on your end and be available via a link. As a license, you transfer a link to a file with a license.

Interaction security is ensured by verifying a signature in the header of each request.

If you have not previously set up fulfillment for your products:

• Open the Merchant Portal and log in
• Go to Products / Overview
  You must have at least one product created for the fulfillment option to be available. In this case, after the search form, you will see the fulfillment setup section
• Click Set up in the fulfillment section
• Select the following License generation method - Web service (or Test web service if you are working in test mode)
• Enter your Web service URL – this is the address of the web service on your end that will receive requests to generate a license. The URL must be accessible over HTTPS
• Select a Data transfer method:
  • GET - parameters will be transferred to your web service in the URL having the following form:
    http://[your-web-service-endpoint-url]?=[parameter1_name]=[parameter1_value]&[parameter2_name]=[parameter2_value]
  • POST - parameters will be transferred in the request body in format JSON
• Enter a Secret key - this value will be used when generating a signature of a request to the web service
• Select what License quantity must be delivered for your product in an order:
  • 1 license per unit - when ordering several units of the same product, you must send the same number of licenses to the customer (e.g., if an order contains 5 units of one product, you must send 5 licenses). If this option is selected, we will send a separate request to get a license for each unit of the same product in one order. All received licenses will be sent to the customer in one email
  • 1 license per product - you must send one license for a product, regardless of the number of product units purchased (e.g., if an order contains 5 units of one product, you must send only one common license)
• Set up customer emails containing licenses
• (Optional) Use parameters to add order/product/customer data to the request
• You can test sending a request before saving the web service
• Click Save

When setting up fulfillment through a web service, you can also set up the emails that will contain licenses sent to customers.

You have two options available:

You can manage data transferred in a request to your web service. By default, the request does not contain any data.

To manage the parameters of the request on the page where you set up fulfillment via your web service:

• Click + Add if you want to add a parameter to the request
• A form must open. It has two fields: parameter name and parameter value
• Select a parameter value in the second field. This is the order or product property that will be transferred to your web service
• Modify the name of the parameter in the first field if necessary

Example of transferring parameters: 

• Your web service is available at: https://you-company.com/license
• Let us assume that you have added a parameter with the following values:
  • Name: ID
  • Value:  product ID
• The customer has paid for some product having ID 123456
• If GET:
  • We will send a request to get a license from your web service to: https://you-company.com/license?ID=123456
• If POST:
  • We will send a request to get a license from your web service to: https://you-company.com/license
  • The request body will contain parameter: {"ID":"19583478"}

If you have already set up fulfillment for your products and want to modify your settings:

• Open the Merchant Portal and log in
• Go to Products / Overview
  You must have at least one product created for the fulfillment option to be available. In this case, after the search form, you will see the fulfillment setup section
• Click Edit in the fulfillment section
• Edit the values of the fields:
  • If you previously used a different license generation method and want to switch to using a web service, select Web service (or Test web service if you are working in test mode) in the field related
  • Further configuration is made the same way as when setting up the web service for the first time

More details on:

• How to secure interaction with signature verification
• How your web service must respond to the request transferred to get a license
• How errors of interaction with the web service are handled

After you have provided the required data to set up your web service, you can test your settings. In this case, you do not have to save any changes to the web service settings.

With this feature, you can send a request to your web service without having to purchase a product through a checkout page.

For this purpose:

• On the page where you set up fulfillment via your web service, click Test
• The system automatically makes a request to your web service based on the current fulfillment settings. If the request contains parameters, test values are inserted into them
• You must see the information about the completed request and the received response of your web service in the modal window

When a test request is executed, no additional actions are taken to process product fulfillment (no customer email with a license and no webhook notification are sent). Only the request is sent.

More details on:

• How to make a purchase in a test environment
• How to test fulfillment in sales mode

If you have not yet developed a web service and want to see a sample request on your end, you can use a mock web service. You must set up a test web service that will receive requests on a special web tool. More details on how to use it.

If you want to test fulfillment processing (e.g., how a webhook or an email with a license are received, etc.), but you do not have a web service yet and do not want to set up an emulator on your end, you can connect our web service emulator. This is our web service that issues test licenses upon request. More details on how to use it.