reseller

is added when reseller has a customer specific business

Add

Description

Places a Themes, Plugins, Logos Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required The Customer under whom the Order should be added.
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method.
additional-param-json String Required The licence parameters for the required item. To fetch the details i.e. id etc., use this method.
Note

This should be a valid JSON, containing keys as the item id and license information.

{"id":"5728fe86-4608-4d36-8193-68cd0a141f38","title":"single-domain"}

invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/restapi/product/themepluginlogo/order?auth-userid=0&api-key=key&customer-id=0&plan-id=0&invoice-option=KeepInvoice&additional-param-json={"id":"57fc0ac0-d508-4ece-b096-041e0a14153b","title":"single-domain"}

Response

Returns a map with the execution details of the Order addition.

Generating a Login Token

Description

Returns an authentication token for a Customer.

You can login to the Customer's Control Panel using the generated token. The Control panel can be accessed at following link, where XXXXX is the generated token.


/servlet/AutoLoginServlet?userLoginId=XXXXX&role=customer


Note

The token will be valid for a duration of only 120 seconds.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required Customer ID of the Customer
ip String Required IP address of the Customer

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/customers/generate-login-token.json?auth-userid=0&api-key=key&customer-id=0&ip=1.1.1.1

Response

Returns a token (String).

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Setting a Default Contact

Description

Sets a default contact for the Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required The Customer for whom you want to set the Default Contacts
type Array of Strings Required Type of default contact to be returned. It can be one or more of following contacts types : Contact, CoopContact, UkContact, EuContact, CnContact, CoContact, CaContact, DeContact, EsContact.
reg-contact-id Integer Required The Registrant Contact of the domain name.
admin-contact-id Integer Required

The Administrative Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .NZ

  • .RU

  • .UK

tech-contact-id Integer Required

The Technical Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .NZ

  • .RU

  • .UK

billing-contact-id Integer Required

The Billing Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .AT

  • .BERLIN

  • .CA

  • .EU

  • .NL

  • .NZ

  • .RU

  • .UK

  • .LONDON

HTTP Method

POST

Example Test URL


https://httpapi.com/api/contacts/modDefault.json?auth-userid=0&api-key=key&customer-id=0&type=Contact&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

Response

Returns a hash map containing the below details of the Default Contacts for each Contact Type requested:

  • registrantContactDetails / adminContactDetails / techContactDetails / billingContactDetails:

    • Contact ID (entity.entityid)

    • Name (contact.name)

    • Company (contact.company)

    • Contact Type (contact.type)

    • Email Address (contact.emailaddr)

    • Telephone Number Country Code (contact.telnocc)

    • Telephone Number (contact.telno)

    • First line of address of the Contact (contact.address1)

    • Second line of address of the Contact (contact.address2)

    • Third line of address of the Contact (contact.address3)

    • City (contact.city)

    • State (contact.state)

    • Country Code (contact.country)

    • ZIP Code (contact.zip)

    • Current Status in the System (entity.currentstatus)

    • Creation Date in the System (contact.creationdt)

    • Creation Date at the Registry (contact.timestamp)

    • Customer ID associated with the Contact (entity.customerid)

  • Registrant Contact ID (registrant)

  • Admin Contact ID (admin)

  • Tech Contact ID (tech)

  • Billing Contact ID (billing)

  • Contact Type (type)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Lock

Description

Applies a Lock on the specified Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Order on which the lock is to be applied
reason String Required The reason for the lock.

HTTP Method

POST

Example Test URL Request


https://httpapi.com/api/domains/reseller-lock/add.json?auth-userid=0&api-key=key&order-id=0&reason=reason-for-lock

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Order to be locked (entityid)

  • Action Type (actiontype)

  • Description of the Order lock Action (actiontypedesc)

  • Action ID of the Order lock Action (eaqid)

  • Order lock Action Status (actionstatus)

  • Description of the Order lock Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR along with an error message will be returned.

Change Primary Domain

Description

Changes the primary domain name for an existing Reseller Windows Hosting Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order ID which is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/resellerhosting/windows/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/resellerhosting/windows/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/resellerhosting/windows/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/resellerhosting/windows/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Change Primary Domain

Description

Changes the primary domain name for an existing Reseller Linux Hosting Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order ID which is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/resellerhosting/linux/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/resellerhosting/linux/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/resellerhosting/linux/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/resellerhosting/linux/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Change Primary Domain

Description

Changes the primary domain name for an existing Multi Domain Windows Hosting order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId which is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/multidomainhosting/windows/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

US, California Server


https://test.httpapi.com/api/multidomainhosting/windows/us/ca/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/multidomainhosting/windows/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/multidomainhosting/windows/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Hong Kong Server


https://test.httpapi.com/api/multidomainhosting/windows/hk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/multidomainhosting/windows/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.

Change Primary Domain

Description

Changes the primary domain name for an existing Multi Domain Linux Hosting order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId which is to be modified.
new-domain-name String Required The new primary domain name.

HTTP Method

POST

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/multidomainhosting/linux/us/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

US, California Server


https://test.httpapi.com/api/multidomainhosting/linux/us/ca/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

UK Server


https://test.httpapi.com/api/multidomainhosting/linux/uk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

India Server


https://test.httpapi.com/api/multidomainhosting/linux/in/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Hong Kong Server


https://test.httpapi.com/api/multidomainhosting/linux/hk/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Turkey Server


https://test.httpapi.com/api/multidomainhosting/linux/tr/change-domain-name.json?auth-userid=0&api-key=key&order-id=0&new-domain-name=domain.com

Response

Returns a map of the execution details of the change primary domain operation.