-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
sadhasivam edited this page Sep 10, 2024
·
1 revision
URL: /api/admin/installations/delete
Method: POST
Description: Deletes specific installations.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
installation_id |
Integer | Required | The ID of the installation record to be deleted. |
{
"success":true,
"message":"Installation Deleted successfully!",
"data":1
}URL: /api/admin/installations/edit
Method: POST
Description: Updates installation details.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
api_key_secret |
String | Required | The API key secret for authentication. |
installation_id |
Integer | Required | The ID of the installation to be updated. |
installation_ip |
String | Optional | The IP address of the installation. |
installation_status |
Integer | Optional | The status of the installation. |
installation_disable_ip |
String | Optional | Flag to disable IP verification. |
delete_record |
Integer | Optional | Flag to indicate if the record should be deleted. |
{
"api_action_success":1,
"api_error_detected":0,
"action_success":1,
"error_detected":0,
"page_message":"Test Product installation on demo.localhost\/manager\/public\/ (127.0.0.2) updated."
}URL: /api/admin/viewInstallations
Method: GET
Description: Displays the list of installations.
This endpoint does not require any parameters.
{
"success": true,
"message": "All the Details of the installation's registered so far are displayed",
"data": [
{
"installation_id": 99999,
"product_id": 101,
"client_id": null,
"license_code": "ABC123XYZ0000",
"installation_ip": "192.168.1.1",
"installation_domain": "fake.localhost/manager/public/api/licenseInstall",
"installation_disable_ip_verification": 0,
"installation_date": "2024-09-08",
"installation_status": 1,
"installation_hash": "123456789abcdef123456789abcdef123456789abcdef123456789abcdef1234",
"created_at": null,
"updated_at": null,
"product_title": "Fake Product Pro",
"client_email": null,
"product": {
"product_id": 101,
"product_title": "Fake Product Pro"
},
"clients": null,
"license": {
"license_id": 88888,
"license_code": "ABC123XYZ0000"
}
},
{
"installation_id": 88888,
"product_id": 202,
"client_id": null,
"license_code": "XYZ456ABC0000",
"installation_ip": "10.0.0.1",
"installation_domain": "fake.supportsite.com",
"installation_disable_ip_verification": 0,
"installation_date": "2024-06-10",
"installation_status": 1,
"installation_hash": "abcdef123456789abcdef123456789abcdef123456789abcdef123456789abcdef",
"created_at": null,
"updated_at": null,
"product_title": "Fake Helpdesk Enterprise",
"client_email": null,
"product": {
"product_id": 202,
"product_title": "Fake Helpdesk Enterprise"
},
"clients": null,
"license": {
"license_id": 77777,
"license_code": "XYZ456ABC0000"
}
}
]
}URL: /api/admin/addInstallation
Method: POST
Description: Adds a new installation.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
license_code |
String | Required | The license code associated with the installation. |
product_id |
Integer | Required | The ID of the product being installed. |
installation_domain |
String | Required | The domain where the installation is taking place. |
installation_date |
Date | Required | The date of the installation. |
installation_status |
Integer | Required | The status of the installation. |
installation_hash |
String | Required | A hash associated with the installation for verification. |
api_key_secret |
String | Required | The API key secret for authenticating the request. |
{
"success":true,
"message":"lang.install_added",
"data":1
}URL: /api/admin/installation/{installation_id}
Method: GET
Description: Fetches installation details for editing.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
installation_id |
Integer | Required | The ID of the installation to be retrieved. |
{
"success": true,
"data": {
"installation": {
"installation_id": 15626,
"product_id": 81,
"client_id": null,
"license_code": "XYZ456ABC0000",
"installation_ip": "127.0.0.2",
"installation_domain": "demo.localhost/manager/public/api/",
"installation_disable_ip_verification": 0,
"installation_date": "2024-09-08",
"installation_status": 1,
"installation_hash": "14e9bhvdjhbd765c9e132eaa6f761ee9b71b0f953d04ca3cad06c6c",
"created_at": null,
"updated_at": null
}
}
}URL: /api/admin/installation/reissue
Method: POST
Description: Removes unwanted installations.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
installation_path |
String | Required | The domain path of the installations to be removed. |
{
"1"
}URL: /api/admin/installation/updateLicenseCode
Method: POST
Description: Updates the license code for an installation.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
old_license_code |
String | Required | The old license code that needs to be deleted. |
{
"1"
}URL: /api/admin/installationView/{installation_id}
Method: GET
Description: Displays detailed information about an installation.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
installation_id |
Integer | Required | The ID of the installation to retrieve. |
{
"success": true,
"message": "Installation details are displayed here",
"data": {
"installation_id": 15626,
"product_id": 81,
"client_id": null,
"license_code": "VGVDGCJRKXQ0000",
"installation_ip": "127.0.0.2",
"installation_domain": "demo.admin\/manager\/public\/api\/",
"installation_disable_ip_verification": 0,
"installation_date": "2024-09-08",
"installation_status": 1,
"installation_hash": "14ejhsvhddhd778c9e132eaa6f761ee9b71b0f953d04ca3cad06c6c",
"created_at": null,
"updated_at": null,
"product": {
"product_id": 81,
"product_title": "Test Product"
},
"clients": null,
"license": {
"license_id": 15915,
"license_code": "VGVDGCJRKXQ0000"
}
}
}URL: /api/admin/installationCallbacks/{installation_id}
Method: GET
Description: Displays the callbacks associated with an installation.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
installation_id |
Integer | Required | The ID of the installation whose callbacks are to be retrieved. |
{
"success": true,
"message": "All installation callbacks are displayed here",
"data": [
{
"callback_id": 112430,
"callback_ip": "119.93.81.200",
"callback_domain": "support.demo.com.ph",
"callback_date_time": "2024-06-10 00:57:20",
"callback_status": 1
},
{
"callback_id": 112406,
"callback_ip": "119.93.81.200",
"callback_domain": "support.demo.com.ph",
"callback_date_time": "2024-06-10 00:04:42",
"callback_status": 0
},
]
}URL: /api/admin/updatedInstallation/edit
Method: POST
Description: Edits an updated installation.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
api_key_secret |
String | Required | The API key secret used to authenticate the request. |
installation_id |
Integer | Required | The ID of the installation to be updated. |
installation_ip |
String | Optional | The IP address associated with the installation. |
installation_status |
Integer | Optional | The status of the installation. Valid values are 0, 1, or 2. |
delete_record |
Integer | Optional | Flag indicating whether the record should be deleted. Set to 1 to delete the record. |
{
"api_action_success":1,
"api_error_detected":0,
"action_success":1,
"error_detected":0,
"page_message":"Test Product installation on demo.localhost\/manager\/public\/ (127.0.0.2) updated."
}URL: /api/admin/showUpdateInstall
Method: GET
Description: Retrieves a list of updated installations.
This endpoint does not require any parameters.
{
"success": true,
"message": "All the Details of the installation's registered so far are displayed",
"data": [
{
"installation_id": 772,
"product_id": 17,
"version_id": 60675,
"installation_ip": "151.97.64.160",
"installation_path": "/home/demo/public_html/public",
"installation_date": "2022-07-07",
"installation_status": 1,
"created_at": null,
"updated_at": null,
"product_title": "Test Product",
"product_sku": "TEST-PRODUCT",
"product_short_description": "",
"product_full_description": "",
"product_url_homepage": "",
"product_url_order": "",
"product_price": 0,
"product_key": "ITDHVWDWSwtoBuxd",
"product_max_active_versions": 0,
"product_date": "0000-00-00",
"product_status": 1,
"deleted_at": null,
"version_number": "v4.10.3",
"version_install_file": "",
"version_install_query": "",
"version_raw_install_query": "",
"version_upgrade_file": "jhvjsbscd36ee3247de3e0f73e600bc2f100f.zip",
"version_upgrade_query": "",
"version_raw_upgrade_query": "",
"version_install_limit": 0,
"version_install_count": 0,
"version_upgrade_limit": 0,
"version_upgrade_count": 10,
"version_changelog": "",
"version_date": "2022-06-17",
"version_expire_date": "0000-00-00",
"version_comments": "",
"version_status": 1,
"expired": 1,
"installation_status_formatted": {
"status_class": "text-green",
"status_text": "Active"
}
},
{
"installation_id": 771,
"product_id": 15,
"version_id": 60665,
"installation_ip": "135.181.45.62",
"installation_path": "/home/demo/support.com/public",
"installation_date": "2022-07-06",
"installation_status": 1,
"created_at": null,
"updated_at": null,
"product_title": "Test Product",
"product_sku": "TEST-PRODUCT",
"product_short_description": "",
"product_full_description": "",
"product_url_homepage": "",
"product_url_order": "",
"product_price": 0,
"product_key": "ITDHVWDWSwtoBuxd",
"product_max_active_versions": 0,
"product_date": "0000-00-00",
"product_status": 1,
"deleted_at": null,
"version_number": "v4.10.3",
"version_install_file": "",
"version_install_query": "",
"version_raw_install_query": "",
"version_upgrade_file": "jhvjsbscd36ee3247de3e0f73e600bc2f100f.zip",
"version_upgrade_query": "",
"version_raw_upgrade_query": "",
"version_install_limit": 0,
"version_install_count": 0,
"version_upgrade_limit": 0,
"version_upgrade_count": 8,
"version_changelog": "",
"version_date": "2022-06-17",
"version_expire_date": "0000-00-00",
"version_comments": "",
"version_status": 1,
"expired": 1,
"installation_status_formatted": {
"status_class": "text-green",
"status_text": "Active"
}
},
]
}