Reseller should be signed up for the CodeGuard product
From the CodeGuard dashboard, you can access and manage your CodeGuard account (view backups of your website/database, restore from older backups, etc.). You can access the CodeGuard dashboard as explained below:
Login to your Control Panel, Search for the domain name for which you have purchased this CodeGuard Order and go to the
Order Information view. See details
Click the View Dashboard link to visit the CodeGuard dashboard.
Use this method to get details of the pricing for the CodeGuard plans for your Customers.
Returns a map with the prices of the CodeGuard plans along with the prices of the other products.
The response structure for the CodeGuard product will be:
"productkey":
{
"plans":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
}
}
}
Example:
"codeguard":
{
"plans":
{
"229":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
},
"230":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"231":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
"232":
{
"renew":
{
"6":0.0
"12":0.0
"24":0.0
},
"add":
{
"6":0.0
"12":0.0
"24":0.0
}
}
}
}
Gets a list and details of the CodeGuard Orders matching the search criteria.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| no-of-records | Integer | Required | Number of Orders to be fetched |
| page-no | Integer | Required | Page number for which details are to be fetched |
| order-id | Array of Integers | Optional | Order IDs of the CodeGuard Orders whose details need to be fetched |
| reseller-id | Array of Integers | Optional | Reseller IDs whose CodeGuard Orders need to be fetched |
| customer-id | Array of Integers | Optional | Customer IDs whose CodeGuard Orders need to be fetched |
| show-child-orders | Boolean | Optional | Whether Sub-Reseller Orders need to be fetched or not |
| status | Array of Strings | Optional | Status of the Order: Active, InActive, Suspended or Deleted |
| domain-name | String | Optional | Name of the Domain of the CodeGuard Order |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of the CodeGuard Orders whose Creation Date is greater than creation-date-start |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of the CodeGuard Orders whose Creation Date is less than creation-date-end |
| expiry-date-start | String | Optional | UNIX TimeStamp for listing of the CodeGuard Orders whose expiry date is greater than expiry-date-start |
| expiry-date-end | String | Optional | UNIX TimeStamp for listing of the CodeGuard Orders whose expiry date is less than expiry-date-end |
| order-by | Array of Strings | Optional | One or more parameters by which you want to sort the Orders. Default is orderid.
Example: If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. |
GET
https://test.httpapi.com/api/codeguard/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1
Returns a hash map containing the below details of the CodeGuard Orders which match the search criteria:
Domain Name (entity.description)
Order Id (orders.orderid)
Customer Id (entity.customerid)
Order Creation Timestamp (orders.creationtime)
Order Expiry Timestamp (orders.endtime)
Current Order Status (entity.currentstatus) - value will be InActive, Active, Suspended or Deleted
Product Name (entitytype.entitytypename)
Product Key (entitytype.entitytypekey)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Gets the associated CodeGuard Order ID from the domain name.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | String | Required | The domain name for which the Order ID is to be fetched |
GET
https://test.httpapi.com/api/codeguard/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.com
Returns the associated CodeGuard Order ID (Integer) for the specified domain name.
Use this method to get details of your plans.
Returns details of the plans of the CodeGuard product, along with the plan details of other Products of the Reseller.
Example:
The response structure for the CodeGuard product will be:
"codeguard":
{
"plan-id":
{
"plan_name":"Plan Name",
"plan_status":"(Active or Paused)"
},
},
Gets the details of an existing CodeGuard Order.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The Order ID of the Order for which the details are to be fetched |
GET
https://test.httpapi.com/api/codeguard/details.json?auth-userid=0&api-key=key&order-id=0
Returns a hash map containing the below details:
Order ID (entityid)
Order Description (description)
Domain Name (domainname)
Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted
Product key (productkey)
Product Category (productcategory)
Plan ID of the CodeGuard Plan (planid)
Status of the CodeGuard Plan (paused)
Order Creation Date (creationtime)
Expiry Date (endtime)
Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)
Reseller Chain by RID (parentkey)
Customer ID Associated with the Order (customerid)
Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)
Whether Order Suspended by Parent Reseller (orderSuspendedByParent)
Whether Order Deletion is Allowed (allowdeletion)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Deletes an existing CodeGuard Order.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The Order ID of the Order which is to be deleted |
POST
https://test.httpapi.com/api/codeguard/delete.json?auth-userid=0&api-key=key&order-id=0
Returns a hash map containing the below details:
Domain Name (description)
Order ID of the CodeGuard Order (entityid)
Action Type (actiontype)
Description of the CodeGuard Order Delete Action (actiontypedesc)
Action ID of the CodeGuard Order Delete Action (eaqid)
CodeGuard Order Delete Action Status (actionstatus)
Description of the CodeGuard Order Delete Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Please wait while you are redirected ....
Please wait while you are redirected ....
Upgrades/Downgrades an existing CodeGuard order.
| Name | Data Type | Required / Optional | |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The Order ID of the Order which is to be upgraded/downgraded |
| new-plan-id | Integer | Required | The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details i.e. plan-id etc, use this method. |
| months | Integer | Required | The number of months in the new plan for which the Order is to be upgraded/downgraded |
| invoice-option | String | Required | This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd |
POST
https://test.httpapi.com/api/codeguard/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice
Returns a hash map containing the below details:
Domain Name (description)
Order ID of the CodeGuard Order (entityid)
Action Type (actiontype)
Description of the CodeGuard Order Upgrade/Downgrade Action (actiontypedesc)
Action ID of the CodeGuard Order Upgrade/Downgrade Action (eaqid)
CodeGuard Order Upgrade/Downgrade Action Status (actionstatus)
Description of the CodeGuard Order Upgrade/Downgrade Action Status (actionstatusdesc)
Invoice ID of the CodeGuard Order Upgrade/Downgrade Invoice (invoiceid)
Selling Currency of the Reseller (sellingcurrencysymbol)
Transaction Amount in the Selling Currency (sellingamount)
Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)
Customer ID associated with the CodeGuard Order (customerid)
invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.