Creating Custom Integrations

You can create a custom integration to request a key (serial number or unlock code) when a product is ordered or revoke a key if a product is returned, the order is refunded or canceled, or there is a chargeback, fraud or some other failure in payment or order authorization.

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.

Creating Key Requests

A key request integration sends a request for a key (serial number of unlock code) when a product set up to use the integration is purchased.

To create a key request custom integration:

Required Role: Integration Configurations ManagerA user role that provides access to Custom Integrations. Search this file for the "user role definitions" topic for more information.
  1. On the Administration menu, select Company, and click Create Custom Integration. The first step of the Create Custom Integration wizard appears.
  2. In the Name field, enter a name for the custom integration. Once you save the integration you will not be able to change the name so make sure you enter the name you want
  3. (Optional) In the Description field, enter a description for the custom integration.
  4. For the Type option, select Serial Number or Unlock Code, depending on the type of key the key request integration will deliver.
  5. Click Next. The second page of the Create Custom Integration wizard appears.
  6. In the Type area, in the Name field, the name you entered on the first page of the wizard for this integration is already in the field. Do not change this name.
  7. In the Key Request area, you will see two different areas where you can enter information for a production environment (the live or active environment) and for a testing environment. You should enter the information for the production environment, but you do not have to enter information for the testing environment. The testing environment will allow you to test the digital rights calls without actually affecting your digital rights keys.
    • The Endpoint URL is the URL where the key request should be sent when an order is placed for a product that has digital rights set up to use the integration. You should already have the system to accept these key request calls set up.
    • If the system requires a Username and Password, enter it in the fields provided.
    • If you want to provide a Description for this set up, enter it in the field provided.
  8. Click Next.
  9. Review the details of the integration you have created. When you are ready to save the integration, click Finish. A message appears asking you if you want to test the settings you have entered. Click Yes to test the set up you have created, or click No to save the integration without testing.

    If you choose to test the settings you have entered, you will receive a message indicating whether the test was successful or not. If the test fails, verify the URL, user name, or password you have entered and try again. 

Creating Key Revocations

A key revocation integration sends a request to revoke or take back a key (serial number of unlock code) that was distributed when a product was purchased. A revocation can happen for many reasons including a refund, return, or fraud.  

To create a key revocation custom integration:

Required Role: Integration Configurations ManagerA user role that provides access to Custom Integrations. Search this file for the "user role definitions" topic for more information.
  1. On the Administration menu, select Company, and click Create Custom Integration. The first step of the Create Custom Integration wizard appears.
  2. In the Name field, enter a name for the custom integration.
  3. (Optional) In the Description field, enter a description for the custom integration.
  4. For the Type option, select Key Revocation.
  5. Click Next. The second page of the Create Custom Integration wizard appears.
  6. In the Key Revocation area, select Use as Default Revocation if you want this revocation to be used by default for all revocation calls. Click Company-level Key Revocation Reasons to see which actions will trigger a revocation. These actions can be set when you Configuring When Key Revocations Occur.
  7. In the Key Revocation area, you will see two different areas where you can enter information for a production environment (the live or active environment) and for a testing environment.
    • The Endpoint URL is the URL where the key revocation request should be sent when a key should be revoked. Keep in mind that the reasons why a key is revoked are set by you when you Configuring When Key Revocations Occur.
    • If the system requires a Username and Password, enter it in the fields provided.
    • If you want to provide a Description for this set up, enter it in the field provided.
  8. Click Next.
  9. Review the details of the integration you have created. When you are ready to save the integration, click Finish. A message appears asking you if you want to test the settings you have entered. Click Yes to test the set up you have created, or click No to save the integration without testing.

    If you choose to test the settings you have entered, you will receive a message indicating whether the test was successful or not. If the test fails, verify the URL, user name, or password you have entered and try again. 

 

Concept Link IconRelated Topics

 

 

© 2019 Digital River, Inc.