E-commerce Documentation

https://woocommerce.com/document/license-manager-woo/
Admin
This project provides documentation and content for an e-commerce system, likely covering aspects...
Tokens:24,817
Snippets:181
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Create License Response Example

Source: https://woocommerce.com/document/license-manager-woo

Example response after successfully creating a license.

```json
{

“success”: true,

“data”:
 {

“id”: 69,

“orderId”: null,

“productId”: 25,

“userId”: 1,

“licenseKey”: “TEST-LICENSE”,

“expiresAt”: “2022-11-01 00:00:00”,

“validFor”: null,

“source”: 3,

“status”: 3,

“timesActivated”: null,

“timesActivatedMax”: 3,

“createdAt”: “2022-08-01 13:34:42”,

“createdBy”: 1,

“updatedAt”: null,

“updatedBy”: null

}

}
```

--------------------------------

### Activate a License Response Example

Source: https://woocommerce.com/document/license-manager-woo

Example response after activating a license, showing updated activation counts and token data.

```json
{
   "success":true,
   "data":{
      "id":1,
      "orderId":165,
      "productId":20,
      "userId":1,
      "licenseKey":"FIRST",
      "expiresAt":"2023-12-28 00:00:00",
      "validFor":null,
      "source":2,
      "status":2,
      "timesActivated":2,
      "timesActivatedMax":5,
      "createdAt":"2023-12-11 07:27:15",
      "updatedAt":"2023-12-22 11:07:44",
      "activationData":{
         "id":6,
         "token":"8f04017840bd40f993e5712403e4ed945a2aeb7c",
         "license_id":1,
         "label":null,
         "source":2,
         "ip_address":"127.0.0.1",
         "user_agent":"PostmanRuntime/7.36.0",
         "meta_data":null,
         "created_at":"2023-12-22 11:07:44",
         "updated_at":null,
         "deactivated_at":null
      }
   }
}
```

--------------------------------

### Update License Response Example

Source: https://woocommerce.com/document/license-manager-woo

Example response after successfully updating a license.

```json
“success”: true,

“data”:
 {

“id”: 31,

“orderId”: null,

“productId”: 30,

“userId”: 2,

“licenseKey”: “UPDATE_LICENSE”,

“expiresAt”: “2022-08-02 00:00:00”,

“validFor”: null,

“source”: 3,

“status”: 3,

“timesActivated”: null,

“timesActivatedMax”: 8,

“createdAt”: “2022-07-29 11:20:24”,

“createdBy”: 1,

“updatedAt”: “2022-07-29 11:24:52”,

“updatedBy”: 1

}

}
```

--------------------------------

### Products/Update Response Example

Source: https://woocommerce.com/document/license-manager-woo

Example response when hitting the Products/Update API. This shows the details of a product associated with a license key.

```json
{

    "success": true,

    "data": null

}
```

--------------------------------

### Response Example: Get Generator

Source: https://woocommerce.com/document/license-manager-woo

This is an example of a successful response when retrieving generator details.

```json
{

    "success": true,

    "data": {

        "id": 7,

        "name": "Generator created by the API",

        "charset": "LICENSE_GENERATE",

        "chunks": 7,

        "chunkLength": 2,

        "timesActivatedMax": "2",

        "separator": "-",

        "prefix": "PRE",

        "suffix": "FIX",

        "expiresIn": "10",

        "createdAt": "2022-08-03 07:49:21",

        "createdBy": "1",

        "updatedAt": null,

        "updatedBy": null

    }

}
```

--------------------------------

### Retrieve Application Response Example

Source: https://woocommerce.com/document/license-manager-woo

Example response when retrieving a single application by its ID. It contains application details like name, type, version, and documentation links.

```json
{

    "success": true,

    "data": {

        "name": "My Application",

        "type": "wordpress",

        "stable_release": "1.4",

        "documentation": "Phasellus aliquet sollicitudin ante non scelerisque. Ut id erat in elite fringilla placerat. Nam luctus est eget quam dictum suscipit. Suspendisse at pellentesque urna. Nam porttitor lectus et tellus tempor, vel vulputate nisl posuere.",

        "support": "Duis rutrum nibh ante, nec euismod sem tristique facilisis. Quisque semper ante ac pharetra eleifend. Nam porta scelerisque volutpat. Nulla suscipit fermentum bibendum.",

        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec semper ante ac enim sodales tincidunt.",

        "gallery": [

            {

                "id": "327",

                "title": "",

                "description": "Nulla suscipit fermentum bibendum.",

                "url": "https://wordpress-***********.cloudwaysapps.com/wp-content/uploads/2023/09/default-point-type.png"

            }

        ]

    }

}
```

--------------------------------

### Response Example: Update Generator

Source: https://woocommerce.com/document/license-manager-woo

This is an example of a successful response after updating a generator.

```json
{

"success": true,

"data": {

"id": 5,

"name": "Update Generator",

"charset": "NEWGEN-RATOR",

"chunks": 6,

"chunkLength": 3,

"timesActivatedMax": "3",

"separator": "-",

"prefix": null,

"suffix": null,

"expiresIn": "15",

"createdAt": "2022-07-28 11:41:21",

"createdBy": "1",

"updatedAt": "2022-08-03 07:55:17",

"updatedBy": "1"

}

}
```

--------------------------------

### Response Example: Generate Licenses

Source: https://woocommerce.com/document/license-manager-woo

This response contains an array of newly generated license keys.

```json
{

"success": true,

"data": [

"ve-le-lv-pe-eD-ve-De-re",

"er-vr-lv-le-ep-pe-Dv-De",

"le-ee-eD-oo-re-pD-lo-lp",

"De-ep-or-er-rp-Dv-Dv-ep",

"vD-ee-De-er-ev-ee-er-lv",

"ee-ee-eD-le-rl-vv-pe-le"

]

}
```

--------------------------------

### Products/Update API Response Example (Pro)

Source: https://woocommerce.com/document/license-manager-woo

Detailed response for the Products/Update API (Pro version). It includes license key, product URL, new version, and other relevant product information.

```json
{

    "success": true,

    "data": {

        "license_key": "API-AOA-NAI-TAT-MIO-TTM-OOA-GEN",

        "url": "http://wpexperts.local/product/ham/",

        "new_version": "2.0",

        "package": "http://wpexperts.local/wp-json/lmfwc/v2/products/download/latest/API-AOA-NAI-TAT-MIO-TTM-OOA-GEN?consumer_key=ck_23bba59cc27dedebf5778b34f0521e948c01f300&consumer_secret=cs_0821d6a54dd8adcb71cf3dbf9d3663c6c1084722",

        "tested": "6.0",

        "requires": "1.0",

        "requires_php": "7.4.1",

        "last_updated": null,

        "rating": null,

        "num_ratings": 0,

        "sections": {

            "changelog": "<p>Initial Release</p>"

        }

    }

}
```

--------------------------------

### Response Example: Validate Customer Licenses

Source: https://woocommerce.com/document/license-manager-woo

This response lists all licenses assigned to a specific customer, including their details and status.

```json
{

    "success": true,

    "data": [

        {

            "id": 70,

            "orderId": 171,

            "productId": 20,

            "userId": 1,

            "licenseKey": "API-OIQ-MOM-AAA-AAA-MIO-ATA-GEN",

            "expiresAt": "2022-08-18 07:01:42",

            "validFor": 15,

            "source": 3,

            "status": 1,

            "timesActivated": null,

            "timesActivatedMax": 3,

            "createdAt": "2022-08-03 06:55:15",

            "createdBy": 1,

            "updatedAt": "2022-08-03 07:01:42",

            "updatedBy": 1

        },

        {

            "id": 71,

            "orderId": 171,

            "productId": 20,

            "userId": 1,

            "licenseKey": "API-MNA-AUA-AMT-OIA-AAA-OAT-GEN",

            "expiresAt": "2022-08-18 07:01:42",

            "validFor": 15,

            "source": 3,

            "status": 1,

            "timesActivated": null,

            "timesActivatedMax": 3,

            "createdAt": "2022-08-03 06:55:15",

            "createdBy": 1,

            "updatedAt": "2022-08-03 07:01:42",

            "updatedBy": 1

        },

        {

            "id": 72,

            "orderId": 171,

            "productId": 20,

            "userId": 1,

            "licenseKey": "API-OOU-AOA-OAT-UOT-OTN-TOA-GEN",

            "expiresAt": "2022-08-18 07:01:42",

            "validFor": 15,

            "source": 3,

            "status": 1,

            "timesActivated": null,

            "timesActivatedMax": 3,

            "createdAt": "2022-08-03 06:55:15",

            "createdBy": 1,

            "updatedAt": "2022-08-03 07:01:42",

            "updatedBy": 1

        }

    ]

}
```

--------------------------------

### Delete a License Response Example

Source: https://woocommerce.com/document/license-manager-woo

Response indicating successful deletion of a license.

```json
{

    "success": true,

    "data": []

}
```

--------------------------------

### Products/Update (PRO)

Source: https://woocommerce.com/document/license-manager-woo

Retrieves product details for which a license key is assigned. This endpoint is useful for displaying product information in the 'Products installed' menu.

```APIDOC
## GET wp-json/lmfwc/v2/products/update/{license_key}

### Description
It will show the products details in which products license key is assigned.

### Method
GET

### Endpoint
wp-json/lmfwc/v2/products/update/{license_key}

### Parameters
#### Path Parameters
- **license_key** (string) - Required - The license key to retrieve product details for.

#### Request Headers
Content-Type: application/json

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the product details.
  - **license_key** (string) - The license key.
  - **url** (string) - The URL of the product.
  - **new_version** (string) - The latest version of the product.
  - **package** (string) - The download URL for the product package.
  - **tested** (string) - The WordPress version the product is tested with.
  - **requires** (string) - The minimum WordPress version required.
  - **requires_php** (string) - The minimum PHP version required.
  - **last_updated** (string) - The date the product was last updated.
  - **rating** (string) - The product rating.
  - **num_ratings** (integer) - The number of ratings.
  - **sections** (object) - Contains details about product sections.
    - **changelog** (string) - The changelog for the product.

### Response Example
```json
{
    "success": true,
    "data": {
        "license_key": "API-AOA-NAI-TAT-MIO-TTM-OOA-GEN",
        "url": "http://wpexperts.local/product/ham/",
        "new_version": "2.0",
        "package": "http://wpexperts.local/wp-json/lmfwc/v2/products/download/latest/API-AOA-NAI-TAT-MIO-TTM-OOA-GEN?consumer_key=ck_23bba59cc27dedebf5778b34f0521e948c01f300&consumer_secret=cs_0821d6a54dd8adcb71cf3dbf9d3663c6c1084722",
        "tested": "6.0",
        "requires": "1.0",
        "requires_php": "7.4.1",
        "last_updated": null,
        "rating": null,
        "num_ratings": 0,
        "sections": {
            "changelog": "<p>Initial Release</p>"
        }
    }
}
```
```

--------------------------------

### Get License

Source: https://woocommerce.com/document/license-manager-woo

Retrieves a specific license from the database using its license key.

```php
function lmfwc_get_license(string $licenseKey)
```

--------------------------------

### Response Example: Delete Generator

Source: https://woocommerce.com/document/license-manager-woo

A successful deletion of a generator will return this response.

```json
{
    "success": true,
    "data": []
}
```

--------------------------------

### Request Body Example: Products/Ping

Source: https://woocommerce.com/document/license-manager-woo

Send this JSON payload to test the connection between the REST API Server and the Client.

```json
{
  "license_key": "API-AOA-NAI-TAT-MIO-TTM-OOA-GEN",
  "product_name": "Ham",
  "host": "localhost"
}
```

--------------------------------

### Get License Meta

Source: https://woocommerce.com/document/license-manager-woo

Retrieves meta data for a specific license key. Use this function to fetch associated metadata like activation counts or expiry dates. The $single parameter determines if a single value or an array of values is returned when multiple entries exist for the same meta key.

```php
function lmfwc_get_license_meta( int $licenseId, string $metaKey, mixed $single = null )
```

--------------------------------

### Get License Meta

Source: https://woocommerce.com/document/license-manager-woo

Retrieves single or multiple license meta entries for a given license ID and meta key. Supports fetching a single value or all values.

```php
function lmfwc_get_license_meta(int $licenseId, string $metaKey, bool $single = false)
```

--------------------------------

### Get Licenses

Source: https://woocommerce.com/document/license-manager-woo

Retrieves multiple licenses based on a query array. The query keys match table columns and values match column values.

```php
function lmfwc_get_licenses(array $query)
```

--------------------------------

### Validate Customer Licenses

Source: https://woocommerce.com/document/license-manager-woo

Get a customer's licenses by their ID.

```APIDOC
## GET wp-json/lmfwc/v2/customers/{customer_id}/licenses

### Description
Get a customer's licenses by their ID. The response contains the licenses assigned to the customer.

### Method
GET

### Endpoint
wp-json/lmfwc/v2/customers/{customer_id}/licenses

### Parameters
#### Path Parameters
- **customer_id** (integer) - Required - The ID of the customer whose licenses to retrieve.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (array) - An array of license objects assigned to the customer.
  - **id** (integer) - The ID of the license.
  - **orderId** (integer) - The ID of the order associated with the license.
  - **productId** (integer) - The ID of the product the license is for.
  - **userId** (integer) - The ID of the user the license is assigned to.
  - **licenseKey** (string) - The license key string.
  - **expiresAt** (string) - The expiration date and time of the license.
  - **validFor** (integer) - The duration the license is valid for in days.
  - **source** (integer) - The source of the license.
  - **status** (integer) - The status of the license.
  - **timesActivated** (string) - The number of times the license has been activated.
  - **timesActivatedMax** (integer) - The maximum number of times the license can be activated.
  - **createdAt** (string) - The timestamp when the license was created.
  - **createdBy** (integer) - The ID of the user who created the license.
  - **updatedAt** (string) - The timestamp when the license was last updated.
  - **updatedBy** (integer) - The ID of the user who last updated the license.

#### Response Example:
```json
{

    "success": true,

    "data": [

        {

            "id": 70,

            "orderId": 171,

            "productId": 20,

            "userId": 1,

            "licenseKey": "API-OIQ-MOM-AAA-AAA-MIO-ATA-GEN",

            "expiresAt": "2022-08-18 07:01:42",

            "validFor": 15,

            "source": 3,

            "status": 1,

            "timesActivated": null,

            "timesActivatedMax": 3,

            "createdAt": "2022-08-03 06:55:15",

            "createdBy": 1,

            "updatedAt": "2022-08-03 07:01:42",

            "updatedBy": 1

        }

    ]

}
```
```

--------------------------------

### Create a License

Source: https://woocommerce.com/document/license-manager-woo

Creates a new license key. You can specify the product ID, license key, expiration date, status, maximum activations, and user ID. Alternatively, you can use 'valid_for' in days instead of 'expires_at'.

```APIDOC
## POST /wp-json/lmfwc/v2/licenses

### Description
Creates a new license key. You can specify the product ID, license key, expiration date, status, maximum activations, and user ID. Alternatively, you can use 'valid_for' in days instead of 'expires_at'.

### Method
POST

### Endpoint
/wp-json/lmfwc/v2/licenses

### Request Body
- **product_id** (string) - Required - The ID of the product.
- **license_key** (string) - Required - The license key.
- **expires_at** (string) - Optional - The expiration date in YYYY-MM-DD format.
- **valid_for** (string) - Optional - The number of days the license is valid for. Cannot be used with 'expires_at'.
- **status** (string) - Optional - The status of the license (e.g., 'active').
- **times_activated_max** (integer) - Optional - The maximum number of times the license can be activated.
- **user_id** (string) - Optional - The ID of the user associated with the license.

### Request Example
```json
{
  "product_id": "25",
  "license_key": "TEST-LICENSE",
  "expires_at": "2022-11-01",
  "status": "active",
  "times_activated_max": 3,
  "user_id": "1"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (object) - Contains the details of the created license.
  - **id** (integer) - The unique identifier for the license.
  - **orderId** (null) - The order ID associated with the license.
  - **productId** (integer) - The ID of the product.
  - **userId** (integer) - The ID of the user.
  - **licenseKey** (string) - The license key.
  - **expiresAt** (string) - The expiration date and time.
  - **validFor** (null) - The validity period in days.
  - **source** (integer) - The source of the license.
  - **status** (integer) - The status of the license.
  - **timesActivated** (null) - The current number of activations.
  - **timesActivatedMax** (integer) - The maximum number of activations allowed.
  - **createdAt** (string) - The timestamp when the license was created.
  - **createdBy** (integer) - The ID of the user who created the license.
  - **updatedAt** (null) - The timestamp when the license was last updated.
  - **updatedBy** (null) - The ID of the user who last updated the license.

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": 69,
    "orderId": null,
    "productId": 25,
    "userId": 1,
    "licenseKey": "TEST-LICENSE",
    "expiresAt": "2022-11-01 00:00:00",
    "validFor": null,
    "source": 3,
    "status": 3,
    "timesActivated": null,
    "timesActivatedMax": 3,
    "createdAt": "2022-08-01 13:34:42",
    "createdBy": 1,
    "updatedAt": null,
    "updatedBy": null
  }
}
```
```

--------------------------------

### List All Licenses

Source: https://woocommerce.com/document/license-manager-woo

Use this route to retrieve all license keys from the database. Be cautious when using this in a production environment; consider disabling the route via settings if not needed. The response includes an array of license key data objects.

```json
{

    "success": true,

    "data": [

        {

"id": 1,

"orderId": 165,

            "productId": 20,

            "userId": 1,

            "licenseKey": "FIRST",

            "expiresAt": "2023-12-28 00:00:00",

         "validFor": null,

            "source": 2,

            "status":  2,

            "timesActivated": 1,

            "timesActivatedMax": 5,

            "createdAt": "2023-12-11 07:27:15",

            "createdBy": 1,

            "updatedAt": "2023-12-22 10:52:18",

            "updatedBy": 1

"activationData": [

        {

            "id": 3,

            "token": "8a242078c59489077dfa420ed870d043f58cb300",

        "license_id": 1,

            "label": null,

           "source": 1,

            "ip_address": "::1",

            "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64;

x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",

"meta_data": null,

           "created_at": "2023-12-15 14:39:11",

            "updated_at": "2023-12-15 14:41:30",

           "deactivated_at": null

}

]

            },

       {

"id": 19,

"orderId": null,

"productId": null,

"userId": null,

"licenseKey": "license_key",

"expiresAt": null,

"validFor": null,

"source": 2,

"status": 3,

"timesActivated": null,

"timesActivatedMax": null,

"createdAt": "2023-12-21 15:19:22",

"createdBy": 1,

"updatedAt": null,

"updatedBy": null,

"activationData": [ ]

}

]

}
```

--------------------------------

### Handle License Keys After Order

Source: https://woocommerce.com/document/license-manager-woo

This action fires after license keys have been generated or sold from stock for an order. It provides order and license details for further processing.

```php
add_action('lmfwc_event_post_order_license_keys', function($args) {

  $orderId = $args['orderId'];
  $licenses = $args['licenses'];

  foreach ($licenses as $license) {
    // Do something
  }

});
```

--------------------------------

### lmfwc_event_post_order_license_keys Action

Source: https://woocommerce.com/document/license-manager-woo

This action fires after license keys have been sold. The hook fires for license keys which have been generated, as well as license keys which have been sold from stock.

```APIDOC
## Action: lmfwc_event_post_order_license_keys

### Description
This action fires after license keys have been sold. The hook fires for license keys which have been generated, as well as license keys which have been sold from stock.

### Parameters
#### `$args` (array) - Description: Associative array containing two keys: `orderId` and `licenses`.

### Usage
```php
add_action('lmfwc_event_post_order_license_keys', function($args) {
  $orderId = $args['orderId'];
  $licenses = $args['licenses'];
  foreach ($licenses as $license) {
    // Do something
  }
});
```
```

--------------------------------

### Create a License

Source: https://woocommerce.com/document/license-manager-woo

Creates a new license key with the given parameters from the request body. The response will contain the newly created license key data object.

```APIDOC
## POST /wp-json/lmfwc/v2/licenses

### Description
Creates a new license key with the given parameters from the request body. It is possible to leave out certain keys, or explicitly set them to “null”. The response will contain the newly created license key data object.

### Method
POST

### Endpoint
/wp-json/lmfwc/v2/licenses

### Request Body
(Details for request body parameters are not provided in the source text, but would typically include fields like productId, userId, licenseKey, expiresAt, etc.)

### Response Example:
(A response example for creating a license is not provided in the source text, but would typically be the newly created license object.)
```

--------------------------------

### List Licenses

Source: https://woocommerce.com/document/license-manager-woo

Retrieves all license keys from the database. Use with caution in production environments.

```APIDOC
## GET /wp-json/lmfwc/v2/licenses

### Description
This route is used to retrieve all license keys from the database. Be very careful, if you do not need to use this API route in your productive environment then it is best to disable the route altogether via the settings page. The response contains an array of license key data objects.

### Method
GET

### Endpoint
/wp-json/lmfwc/v2/licenses

### Response Example:
{

    "success": true,

    "data": [

        {

"id": 1,

"orderId": 165,

            "productId": 20,

            "userId": 1,

            "licenseKey": "FIRST",

            "expiresAt": "2023-12-28 00:00:00",

         "validFor": null,

            "source": 2,

            "status":  2,

            "timesActivated": 1,

            "timesActivatedMax": 5,

            "createdAt": "2023-12-11 07:27:15",

            "createdBy": 1,

            "updatedAt": "2023-12-22 10:52:18",

            "updatedBy": 1,

"activationData": [

        {

            "id": 3,

            "token": "8a242078c59489077dfa420ed870d043f58cb300",

        "license_id": 1,

            "label": null,

           "source": 1,

            "ip_address": "::1",

            "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64;\n
x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",

"meta_data": null,

           "created_at": "2023-12-15 14:39:11",

            "updated_at": "2023-12-15 14:41:30",

           "deactivated_at": null

}

]

            },

       {

"id": 19,

"orderId": null,

"productId": null,

"userId": null,

"licenseKey": "license_key",

"expiresAt": null,

"validFor": null,

"source": 2,

"status": 3,

"timesActivated": null,

"timesActivatedMax": null,

"createdAt": "2023-12-21 15:19:22",

"createdBy": 1,

"updatedAt": null,

"updatedBy": null,

"activationData": [ ]

}

]

}
```

--------------------------------

### Request Body: Generate Licenses

Source: https://woocommerce.com/document/license-manager-woo

Specify the amount, status, and associated order/product/user IDs when generating licenses.

```json
{
  "amount": 6,
  "save": true,
  "status": "active",
  "order_id": null,
  "product_id": 25,
  "user_id": 1
}
```

--------------------------------

### Modify REST API Response Data

Source: https://woocommerce.com/document/license-manager-woo

Hook into the `lmfwc_rest_api_pre_response` filter to modify the activation response. This example creates an activation object with an ID, proxy, and IP address, saves it to license meta, and adds it to the response data. Use this to add custom information to API responses.

```php
function lmfwc_tutorial_modify_response($method, $route, $data) {
    // First check if we are on the correct route
    if ($route !== 'v2/licenses/activate/{license_key}') {
        return $data;
    }

    // Now we will save an activation object for this license/activation. The
    // activation object will be an array consisting of an ID, the proxy (if
    // The remote party is using a proxy), and the user's remote address (IP).
    // Please note that we're just using the PHP "uniqid()" method for the ID,
    // you can of course use something more appropriate.
    $activation = array(
        'id' => uniqid(),
        'http_x_forwarded_for' => $_SERVER['HTTP_X_FORWARDED_FOR'],
        'remote_addr' => $_SERVER['REMOTE_ADDR']
    );

    // Save to the license meta
    lmfwc_add_license_meta($data['id'], 'activation', $activation);

    // Add the $activation variable to the response
    $data['activation'] = $activation;

    // Return the result
    return $data;
}
add_filter('lmfwc_rest_api_pre_response', 'lmfwc_tutorial_modify_response', 10,

```

--------------------------------

### Add License

Source: https://woocommerce.com/document/license-manager-woo

Adds a new license to the database. Requires the license key and an optional array of license data.

```php
function lmfwc_add_license(string $licenseKey, array $licenseData)
```

--------------------------------

### Create a New License

Source: https://woocommerce.com/document/license-manager-woo

Use this endpoint to create a new license. You can specify expiration date or duration in days, but not both. Ensure 'status' is set to 'active' for an active license.

```json
{
  "product_id": "25",
  "license_key": "TEST-LICENSE",
  "expires_at": "2022-11-01",
  "status": "active",
  "times_activated_max": 3,
  "user_id": "1"
}
```

--------------------------------

### Download Application (Pro)

Source: https://woocommerce.com/document/license-manager-woo

Downloads the latest version of an application using its activation token. This API is intended for browser use.

```APIDOC
## GET {SITE_URL}/wp-json/lmfwc/v2/application/download/{activation_token}

### Description
Download the latest version of your application when this API is hit, please use this API only in the browser.

### Method
GET

### Endpoint
{SITE_URL}/wp-json/lmfwc/v2/application/download/{activation_token}

### Parameters
#### Path Parameters
- **activation_token** (string) - Required - The activation token for the application download.

#### Request Headers
Content-Type: application/json

### Usage Instructions
1. Open a new tab and paste the request URL in the search bar.
2. Enter the consumer key and consumer secret in the alert bar.
3. Click on the 'Sign in' button.
4. The application will be downloaded.

### Response
This endpoint initiates a file download. Specific success/error responses are not detailed in the source.
```

--------------------------------

### Download Products (Pro)

Source: https://woocommerce.com/document/license-manager-woo

Downloads the latest version of a product associated with a given license key. This API is intended for browser use.

```APIDOC
## GET wp-json/lmfwc/v2/products/download/latest/{license_key}

### Description
Download the latest products of your license when hit this API, please use this API only in the browser..

### Method
GET

### Endpoint
wp-json/lmfwc/v2/products/download/latest/{license_key}

### Parameters
#### Path Parameters
- **license_key** (string) - Required - The license key for which to download the latest product.

### Response
This endpoint initiates a file download. Specific success/error responses are not detailed in the source.
```

--------------------------------

### lmfwc_get_license_meta()

Source: https://woocommerce.com/document/license-manager-woo

Retrieves meta information for a given license key. It can fetch a single meta entry or all entries associated with a license.

```APIDOC
## lmfwc_get_license_meta()

### Description
Retrieves meta information for a given license key. It can fetch a single meta entry or all entries associated with a license.

### Method
Not applicable (PHP function)

### Parameters
#### Path Parameters
- **$licenseId** (string) - Required - The ID of the license key.
- **$metaKey** (string) - Required - Name of the meta entry.
- **$single** (bool) - Optional - If multiple meta entries exists, setting this parameter to true will retrieve all of them.

### Response
#### Success Response
- **mixed|mixed[]|bool** - Meta value on success, false on failure.

### Response Example
Not applicable (PHP function)
```

--------------------------------

### Add License Meta

Source: https://woocommerce.com/document/license-manager-woo

Adds a new meta entry to a license. If the meta key already exists, a new row is added to the database table.

```php
function lmfwc_add_license_meta(int $licenseId, string $metaKey, mixed $metaValue)
```

--------------------------------

### lmfwc_get_licenses()

Source: https://woocommerce.com/document/license-manager-woo

Retrieves multiple licenses from the database based on a query array.

```APIDOC
## lmfwc_get_licenses()

### Description
Retrieves multiple existing licenses from the database.

### Parameters
#### Path Parameters
- **query** (array) - Required - Key/value pairs. The keys will be used to match the license table columns names, and the values will be used to match the values of those columns.

### Return Value
(bool|LicenseManagerForWooCommerce\Models\Resources\License[]) - License model array on success, false on failure.
```

--------------------------------

### Retrieve a Single License

Source: https://woocommerce.com/document/license-manager-woo

Retrieves a single license key by its string. The response contains the queried license key data object.

```json
{

"success": true,

"data": {

"id": 1,

"orderId": 165,

"productId": 20,

"userId": 1,

"licenseKey": "FIRST",

"expiresAt": "2023-12-28 00:00:00",

"validFor": null,

"source": 2,

"status": 2,

"timesActivated": 1,

"timesActivatedMax": 5,

"createdAt": "2023-12-11 07:27:15",

"createdBy": 1,

"updatedAt": "2023-12-22 10:52:18",

"activationData": [

{

"id": 3,

"token": "8a242078c59489077dfa420ed870d043f58cb300",

"license_id": 1,

"label": null,

"source": 1,

"ip_address": "::1",

"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",

"meta_data": null,

"created_at": "2023-12-15 14:39:11",

"updated_at": "2023-12-15 14:41:30",

"deactivated_at": null

}

]

}

}
```

--------------------------------

### lmfwc_add_license()

Source: https://woocommerce.com/document/license-manager-woo

Adds a new license to the database. It takes a license key and an optional array of license data.

```APIDOC
## lmfwc_add_license()

### Description
Adds a new license to the database.

### Parameters
#### Path Parameters
- **licenseKey** (string) - Required - The license key being added.
- **licenseData** (array) - Optional - Key/value pairs. The keys must match the license table columns names.

### Return Value
(bool|LicenseManagerForWooCommerce\Models\Resources\License) - License model on success, false on failure.
```

--------------------------------

### lmfwc_get_license_meta()

Source: https://woocommerce.com/document/license-manager-woo

Retrieves single or multiple meta entries associated with a license.

```APIDOC
## lmfwc_get_license_meta()

### Description
Retrieves single or multiple license meta entries.

### Parameters
#### Path Parameters
- **licenseId** (int) - Required - The ID of the license key.
- **metaKey** (string) - Required - Name of the meta entry.
- **single** (bool) - Optional - Defaults to false. If true, returns a single value. If false, returns an array of values.

### Return Value
(mixed|bool) - Meta value(s) on success, false on failure.
```

--------------------------------

### Products/Ping

Source: https://woocommerce.com/document/license-manager-woo

Create a ping request to check for the connection between REST API Server and the Client.

```APIDOC
## POST wp-json/lmfwc/v2/products/ping

### Description
Create a ping request to check for the connection between REST API Server and the Client.

### Method
POST

### Endpoint
wp-json/lmfwc/v2/products/ping

### Request Body
- **license_key** (string) - Required - The license key to use for the ping request.
- **product_name** (string) - Required - The name of the product.
- **host** (string) - Required - The host to ping.

### Request Body Example:
```json
{
  "license_key": "API-AOA-NAI-TAT-MIO-TTM-OOA-GEN",
  "product_name": "Ham",
  "host": "localhost"
}
```
```

--------------------------------

### Activate License

Source: https://woocommerce.com/document/license-manager-woo

Activates a license if it has not reached its maximum activation count. Requires the license key.

```php
function lmfwc_activate_license(string $licenseKey)
```

--------------------------------

### Retrieve an Application

Source: https://woocommerce.com/document/license-manager-woo

Retrieves details for a single application using its ID. The response includes the application's data object.

```APIDOC
## GET {SITE_URL}/wp-json/lmfwc/v2/application/{application_id}

### Description
Retrieves a single application by its ID. The response contains the queried application data object.

### Method
GET

### Endpoint
{SITE_URL}/wp-json/lmfwc/v2/application/{application_id}

### Parameters
#### Path Parameters
- **application_id** (string) - Required - The ID of the application to retrieve.

#### Request Headers
Content-Type: application/json

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the application data.
  - **name** (string) - The name of the application.
  - **type** (string) - The type of the application (e.g., 'wordpress').
  - **stable_release** (string) - The stable release version of the application.
  - **documentation** (string) - Documentation URL or description.
  - **support** (string) - Support information or URL.
  - **description** (string) - A description of the application.
  - **gallery** (array) - A list of gallery items.
    - **id** (string) - The ID of the gallery item.
    - **title** (string) - The title of the gallery item.
    - **description** (string) - The description of the gallery item.
    - **url** (string) - The URL of the gallery item image.

### Response Example
```json
{
    "success": true,
    "data": {
        "name": "My Application",
        "type": "wordpress",
        "stable_release": "1.4",
        "documentation": "Phasellus aliquet sollicitudin ante non scelerisque. Ut id erat in elite fringilla placerat. Nam luctus est eget quam dictum suscipit. Suspendisse at pellentesque urna. Nam porttitor lectus et tellus tempor, vel vulputate nisl posuere.",
        "support": "Duis rutrum nibh ante, nec euismod sem tristique facilisis. Quisque semper ante ac pharetra eleifend. Nam porta scelerisque volutpat. Nulla suscipit fermentum bibendum.",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec semper ante ac enim sodales tincidunt.",
        "gallery": [
            {
                "id": "327",
                "title": "",
                "description": "Nulla suscipit fermentum bibendum.",
                "url": "https://wordpress-***********.cloudwaysapps.com/wp-content/uploads/2023/09/default-point-type.png"
            }
        ]
    }
}
```
```

--------------------------------

### Retrieve a License

Source: https://woocommerce.com/document/license-manager-woo

Retrieves a single license key by its license key string. The response contains the queried license key data object.

```APIDOC
## GET /wp-json/lmfwc/v2/licenses/{license_key}

### Description
Retrieves a single license key by the license key string itself. The response contains the queried license key data object.

### Method
GET

### Endpoint
/wp-json/lmfwc/v2/licenses/{license_key}

### Response Example:
{

"success": true,

"data": {

"id": 1,

"orderId": 165,

"productId": 20,

"userId": 1,

"licenseKey": "FIRST",

"expiresAt": "2023-12-28 00:00:00",

"validFor": null,

"source": 2,

"status": 2,

"timesActivated": 1,

"timesActivatedMax": 5,

"createdAt": "2023-12-11 07:27:15",

"createdBy": 1,

"updatedAt": "2023-12-22 10:52:18",

"activationData": [

{

"id": 3,

"token": "8a242078c59489077dfa420ed870d043f58cb300",

"license_id": 1,

"label": null,

"source": 1,

"ip_address": "::1",

"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",

"meta_data": null,

"created_at": "2023-12-15 14:39:11",

"updated_at": "2023-12-15 14:41:30",

"deactivated_at": null

}

]

}

}
```

--------------------------------

### Generate Licenses

Source: https://woocommerce.com/document/license-manager-woo

Generate licenses by generator ID. The response contains the generated keys.

```APIDOC
## POST /wp-json/lmfwc/v2/generators/{generator_id}/generate

### Description
Generate licenses by generator ID. The response contains the generated keys.

### Method
POST

### Endpoint
/wp-json/lmfwc/v2/generators/{generator_id}/generate

### Parameters
#### Path Parameters
- **generator_id** (integer) - Required - The ID of the generator to use for creating licenses.

#### Request Body
- **amount** (integer) - Required - The number of licenses to generate.
- **save** (boolean) - Optional - Whether to save the generated licenses.
- **status** (string) - Optional - The status to assign to the generated licenses (e.g., 'active').
- **order_id** (integer) - Optional - The ID of the order associated with these licenses.
- **product_id** (integer) - Optional - The ID of the product for which licenses are generated.
- **user_id** (integer) - Optional - The ID of the user to whom the licenses are assigned.

### Request Example
```json
{
  "amount": 6,
  "save": true,
  "status": "active",
  "order_id": null,
  "product_id": 25,
  "user_id": 1
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **data** (array) - An array of generated license keys.

#### Response Example:
```json
{

    "success": true,

    "data": [

        "ve-le-lv-pe-eD-ve-De-re",

        "er-vr-lv-le-ep-pe-Dv-De",

        "le-ee-eD-oo-re-pD-lo-lp",

        "De-ep-or-er-rp-Dv-Dv-ep",

        "vD-ee-De-er-ev-ee-er-lv",

        "ee-ee-eD-le-rl-vv-pe-le"

    ]

}
```
```
Tokens:
Raw