Skip to content

License

Jump to bottom
sadhasivam edited this page Sep 10, 2024 · 1 revision

Add License

URL: /api/admin/license/add

Method: POST

Description: Adds a new license.

Parameters

Parameter Type Required/Optional Description
api_key_secret String Required API key for authentication.
product_id Integer Required The ID of the product for which the license is being added.
license_code String Required The unique code for the license.
license_require_domain Integer Required Indicates whether the license requires a domain (1 for yes, 0 for no).
license_status Integer Required The status of the license (0 for inactive, 1 for active, 2 for expired).
client_id Integer Optional The ID of the client to whom the license is assigned. If not provided, it will be set to NULL.
license_order_number String Optional The order number associated with the license.
license_ip String Optional The IP address associated with the license.
license_domain String Optional The domain associated with the license.
license_limit Integer Optional The limit associated with the license.
license_expire_date String Optional The expiration date of the license in YYYY-MM-DD format.
license_updates_date String Optional The date of the last update for the license in YYYY-MM-DD format.
license_support_date String Optional The support date for the license in YYYY-MM-DD format.
license_comments String Optional Additional comments related to the license.

Response

{
    "success": true,
    "message": "New License added Successfully",
    "data": "HJDDSPZ5UT4I25I"
}

View Licenses

URL: /api/admin/viewLicenses

Method: GET

Description: Displays the list of licenses.

Parameters

This endpoint does not require any parameters.

Response

{
    "success": true,
    "message": "All the Details of the license's registered so far are displayed",
    "data": [
            {
                "license_id": 18999,
                "product_id": 83,
                "client_id": null,
                "license_code": "SYZJUSPZ5UT4I25I",
                "license_ip": "",
                "license_limit": 0,
                "license_expire_date": "2024-09-18",
                "license_support_date": "2024-09-20",
                "license_order_number": "",
                "license_domain": "",
                "license_date": "2024-09-09",
                "license_updates_date": "2024-09-19",
                "license_status": 1,
                "product_title": "Test Product",
                "client_email": null,
                "license_order_url": "",
                "installation_counts": 0,
                "latest_call_backs": null,
                "call_backs_count": 0,
                "product": {
                    "product_id": 83,
                    "product_title": "Test Product"
                },
                "clients": null
            },
            {
                "license_id": 18984,
                "product_id": 218,
                "client_id": null,
                "license_code": "HHGVVFFCHGFVHG",
                "license_ip": "",
                "license_limit": 0,
                "license_expire_date": "2024-08-07",
                "license_support_date": "2024-08-07",
                "license_order_number": "",
                "license_domain": "",
                "license_date": "2024-08-06",
                "license_updates_date": "2024-08-07",
                "license_status": 1,
                "product_title": "Test",
                "client_email": null,
                "license_order_url": "",
                "installation_counts": 0,
                "latest_call_backs": null,
                "call_backs_count": 0,
                "product": {
                    "product_id": 218,
                    "product_title": "Test"
                },
                "clients": null
            },
    ]
}

Delete License

URL: /api/admin/license/delete

Method: POST

Description: Deletes a license.

Parameters

Parameter Type Required/Optional Description
license_id Integer Required The ID of the license to be deleted.
api_key_secret String Required API key for authentication.

Response

{
    "success": true,
    "message": "The record you have selected has been deleted successfully",
    "data": 1
}

Edit License

URL: /api/admin/license/edit

Method: POST

Description: Updates license details.

Parameters

Parameter Type Required/Optional Description
api_key_secret String Required API key for authentication.
license_id Integer Required The ID of the license to be updated.
product_id Integer Required The ID of the product associated with the license.
license_require_domain Integer Required Whether the license requires a domain.
license_status Integer Required The status of the license.
client_id Integer Optional The ID of the client associated with the license.
license_code String Optional The code of the license.
license_order_number String Optional The order number associated with the license.
license_ip String Optional The IP address associated with the license.
license_domain String Optional The domain associated with the license.
license_limit Integer Optional The limit associated with the license.
license_expire_date Date Optional The expiration date of the license.
license_updates_date Date Optional The date of the last update to the license.
license_support_date Date Optional The date of the last support for the license.
license_comments String Optional Comments associated with the license.

Response

{
    "success": true,
    "message": "The license Details has been Updated Successfully",
    "data": "HVUHKDFFCHGFVHG"
}

Get License for Editing

URL: /api/admin/license/{license_id}

Method: GET

Description: Fetches license details for editing.

Parameters

Parameter Type Required/Optional Description
license_id Integer Required The ID of the license to be retrieved.

Response

{
    "success": true,
    "data": {
        "license": {
            "license_id": 18984,
            "product_id": 218,
            "client_id": null,
            "license_code": "HVHJHHFFCHGFVHG",
            "license_order_number": "",
            "license_ip": "",
            "license_domain": "",
            "license_require_domain": 1,
            "license_limit": 0,
            "license_date": "2024-08-06",
            "license_cancel_date": "0000-00-00",
            "license_expire_date": "2024-08-07",
            "license_expire_email_date": "2024-08-07",
            "license_updates_date": "2024-08-07",
            "license_updates_email_date": "2024-08-07",
            "license_support_date": "2024-08-15",
            "license_support_email_date": "0000-00-00",
            "license_comments": "",
            "license_envato": 0,
            "license_status": 1,
            "created_at": null,
            "updated_at": null
        },
        "product_name": [
            {
                "product_title": "Test",
                "product_id": 218
            }
        ],
        "client_name": []
    }
}

Deactivate License

URL: /api/admin/license/deactivate

Method: POST

Description: Deactivates a license.

Parameters

Parameter Type Required/Optional Description
license_code String Required The license code of the license to be deactivated.

Response

{
    //No response for this api
}

Update License Code

URL: /api/admin/license/updateLicenseCode

Method: POST

Description: Updates the license code.

Parameters

Parameter Type Required/Optional Description
old_license_code String Required The current license code that needs to be updated.
license_code String Required The new license code to replace the old one.

Response

{
     //No response for this api
}

View License Details

URL: /api/admin/licenseView/{license_id}

Method: GET

Description: Displays detailed information about a license.

Parameters

Parameter Type Required/Optional Description
license_id Integer Required The ID of the license to be retrieved.

Response

{
    "success": true,
    "message": "License details are displayed here",
    "data": {
        "license_id": 18984,
        "product_id": 218,
        "client_id": null,
        "license_ip": "",
        "license_code": "HVTHDVGFFCHGFVHG",
        "license_limit": 0,
        "license_expire_date": "2024-08-07",
        "license_support_date": "2024-08-15",
        "license_order_number": "",
        "license_domain": "",
        "license_date": "2024-08-06",
        "license_updates_date": "2024-08-07",
        "license_status": 0,
        "license_order_url": "",
        "installation_counts": 0,
        "latest_call_backs": null,
        "call_backs_count": 0,
        "product": {
            "product_id": 218,
            "product_title": "Test"
        },
        "clients": null
    }
}

View License Installations

URL: /api/admin/licenseInstallation/{license_id}

Method: GET

Description: Displays the installations associated with a license.

Parameters

Parameter Type Required/Optional Description
license_id Integer Required The ID of the license for which installations are being retrieved.

Response

{
    "success": true,
    "message": "All license installations are displayed here",
    "data": [
        {
                "installation_id": 15628,
                "client_id": null,
                "product_id": 17,
                "installation_domain": "demo.localhost\/manager\/public",
                "installation_ip": "127.0.0.1",
                "installation_date": "2024-09-08",
                "installation_status": 1
            },
            {
                "installation_id": 15611,
                "client_id": null,
                "product_id": 17,
                "installation_domain": "demo.admin.vn",
                "installation_ip": "18.141.94.210",
                "installation_date": "2024-06-09",
                "installation_status": 1
            }
    ]
}

View License Callbacks

URL: /api/admin/licenseCallbacks/{license_id}

Method: GET

Description: Displays the callbacks associated with a license.

Parameters

Parameter Type Required/Optional Description
license_id Integer Required The ID of the license for which callbacks are being retrieved.

Response

{
    "success": true,
     "message": "All license callbacks are displayed here",
    "data": [
        {
                "callback_id": 112490,
                "product_id": 17,
                "client_id": null,
                "license_code": "TWYTDTYCYEFR0000",
                "callback_ip": "127.0.0.1",
                "callback_domain": "demo.localhost\/manager\/public",
                "callback_date_time": "2024-09-09 05:38:52",
                "callback_status": 1,
                "created_at": null,
                "updated_at": null
            },
            {
                "callback_id": 112489,
                "product_id": 17,
                "client_id": null,
                "license_code": "TWYTDTYCYEFR0000",
                "callback_ip": "127.0.0.1",
                "callback_domain": "demo.localhost\/manager\/public",
                "callback_date_time": "2024-09-08 19:43:46",
                "callback_status": 1,
                "created_at": null,
                "updated_at": null
            },
    ]
}

Get License Columns

URL: /api/admin/getLicenseColumn

Method: GET

Description: Retrieves the user specific license columns.

Parameters

This endpoint does not require any parameters.

Response

{
    "success": true,
    "data": [
        "license_ip",
        "license_limit",
        "license_order_number",
        "license_date",
        "license_status",
        "license_code",
        "installation_counts",
        "latest_call_backs",
        "call_backs_count",
        "product_title"
    ]
}

Save License Columns

URL: /api/admin/saveLicenseColumn

Method: POST

Description: Saves the user specific license columns.

Parameters

This endpoint does not require any parameters.

Response

{
    "success":true,
    "message":"Column Saved Successfully",
    "data":""
}

View License Installation Logs

URL: /api/admin/installationLogs/{id}

Method: GET

Description: Displays the installation logs associated with a license.

Parameters

Parameter Type Required/Optional Description
license_id Integer Required The ID of the license for which installation logs are being retrieved.

Response

{
    "success": true,
    "data": [
         {
                "id": 3665,
                "license_code": "TCCYG3REIYEFR0000",
                "version_number": null,
                "installation_ip": "127.0.0.1",
                "installation_domain": "demo.localhost\/manager\/public",
                "installation_last_active_date": "2024-09-09 07:19:17",
                "installation_status": 1,
                "created_at": null,
                "updated_at": null
            },
            {
                "id": 3664,
                "license_code": "TCCYG3REIYEFR0000",
                "version_number": null,
                "installation_ip": "127.0.0.1",
                "installation_domain": "demo.localhost\/manager\/public",
                "installation_last_active_date": "2024-09-08 16:51:56",
                "installation_status": 1,
                "created_at": null,
                "updated_at": null
            },
    ]
}

Update Installation Logs

URL: /api/admin/updateInstallationLogs

Method: POST

Description: Updates the installation logs.

Parameters

Parameter Type Required/Optional Description
api_key_secret String Required The API key secret used to authenticate the request.
root_url String Required The root URL of the installation for domain extraction.
version_number String Required The version number of the installation.
installation_ip String Optional The IP address associated with the installation.

Response

{
    "api_action_success": 1,
    "api_error_detected": 0,
    "action_success": 0,
    "error_detected": 1,
    "page_message": "Installation Logs updated successfully"
}

Get Installation Logs

URL: /api/admin/getInstallationLogs

Method: POST

Description: Retrieves the installation logs.

Parameters

Parameter Type Required/Optional Description
api_key_secret String Required The API key secret used to authenticate the request.
license_code String Required The license code to retrieve installation logs for.

Response

{
    "api_action_success": 1,
    "api_error_detected": 0,
    "action_success": 0,
    "error_detected": 1,
    "page_message":[ {
                "id": 3665,
                "license_code": "TCCYG3REIYEFR0000",
                "version_number": null,
                "installation_ip": "127.0.0.1",
                "installation_domain": "demo.localhost\/manager\/public",
                "installation_last_active_date": "2024-09-09 07:19:17",
                "installation_status": 1,
                "created_at": null,
                "updated_at": null
            },
            {
                "id": 3664,
                "license_code": "TCCYG3REIYEFR0000",
                "version_number": null,
                "installation_ip": "127.0.0.1",
                "installation_domain": "demo.localhost\/manager\/public",
                "installation_last_active_date": "2024-09-08 16:51:56",
                "installation_status": 1,
                "created_at": null,
                "updated_at": null
            },
    ]
}

Home | API-Documentation | FAQ's | Troubleshooting | Protecting your script | Update

API Documentation

Clone this wiki locally