Creating a custom integration

You can create a custom integration to request a key (serial number or unlock code) when a customer orders product. You can also create a custom integration to revoke a key when:

• A customer returns a product
• You refund or cancel an order
• A chargeback or fraud occurs
• A customer fails to pay for or authorize the order

Create Custom Integration attributes

Attribute	Description
Name	The name of 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.
Type	The type of custom integration. The options are as follows: Serial Number Unlock Code Key Revocation
Type
Name	The name of the custom integration. Do not change this name.
Description	The description of the custom integration.
Type	The type of custom integration.
Key Request	A key request occurs when a customer purchases a product that is set up to use digital rights from an external source. The system sends the key request to the specified endpoint URL. There are two different areas where you can enter information. Production Environment—This is the live or active environment. Enter the information for the production environment. Test Environment—This is a test environment. 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.
Key Revocation
Use as Default Revocation	Select this checkbox if you want to use this revocation as the default for all revocation calls. Click Company-level Key Revocation Reasons to see which actions will trigger a revocation. See How to configure when key revocations occur for instructions. This checkbox only appears when you select the Key Revocation option as the custom integration type.
Endpoint URL	URL where the key request should be sent when a customer places an order for a product that has digital rights set up to use the integration. The system associated with the URL should already be set up to accept these key request calls.
User Name	The user name associated with the Endpoint URL.
Password	The password associated with the Endpoint URL.
Description	Enter a description of the system associated with the Endpoint URL.

How to create a key request integration

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

1. Select Administration, select Company and then click Create Custom Integration. The Type step in the Create Custom Integration wizard appears.
2. Enter the name of the custom integration in the Name field. 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. Enter a description of the custom integration in the Description field.
4. Choose one of the following options for the Type option: Serial Number or Unlock Code, depending on the type of key the key request integration will deliver.
5. Click Next. The Settings step appears.
6. Complete the fields under Key Request.
7. Click Next. The Review step appears.
8. Review the details of the integration you created.
9. Click Finish. A message appears asking you if you want to test the settings you entered.

10. To test all environments with the provided settings, click Yes. To save the settings and skip testing, click No.

    If you choose to test the settings you 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 entered and try again.

How to create a key revocation custom integration

A key revocation integration sends a request to revoke a key (serial number of unlock code). A key can be revoked for a refund, return, or fraud.

1. Select Administration, select Company and then click Create Custom Integration. The Type step in the Create Custom Integration wizard appears.
2. Enter the name of the custom integration in the Name field. 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. Enter a description of the custom integration in the Description field.
4. Select Key Revocation for the Type option.
5. Click Next. The Settings step appears.
6. Under Key Revocation, select the Use as Default Revocation checkbox if you want to use this revocation as the default for all revocation calls.
7. Complete the fields under Production Environment Settings and Test Environment Settings.
8. Click Next. The Review step appears.
9. Review the details of the integration you created.
10. Click Finish. A message appears asking you if you want to test the settings you entered.

11. To test all environments with the provided settings, click Yes. To save the settings and skip testing, click No.

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