reseller

is added when reseller has a customer specific business

IMPORTANT: API Abuse

The API is provided to you to conduct normal business activities through your own interface(s). Any activity using the API, that causes lossage or creates service degradation for other users, is constituted as abuse by . A few examples of API Abuse activities are stated below:

  1. Sending a huge number of Check Availability commands for already registered domain names or Register Domain commands, repeatedly.

  2. Adding a large number of Sub-Resellers and/or Customers who do not have any Orders.

Upon detection of API Abuse, would take preventive action to mitigate abuse, as detailed below:

  • If the number of calls exceeds beyond a reasonable limit, your IP address will be temporarily blocked from accessing our servers, for a period of 24 hrs. During this time, you will be unable to make any calls to our Servers using the API. This block will be automatically cleared after 24 hours and an email notification to that effect will be sent to you. However repeated abuse will result in permanent blocking of the Reseller account.

  • If the number of simultaneous connections from a single IP Address, increases beyond a certain number, the system would automatically drop these excessive connections of that Reseller.

Managing DNS, Email, Hosting, Live Chat, Website Builder Services through your SOAP API Integration

Note

The SOAP API has been deprecated. You are advised to use the HTTP API instead.

The following Services reside on separate servers from the ones you connect to, via the SOAP API Kits, due to which your Customers need to login to their (individual) Control Panels, for managing
them:

  • DNS

  • Email (Free Email Account [POP/IMAP] and Email Forwarding)

  • Web Hosting

  • Email Hosting

  • Live Chat

  • Website Builder

now provides you with another method of directly allowing access to your Customer, to manage their DNS, Email, Web Hosting,
Email Hosting, Live Chat and Website Builder Services from your interfaces itself.

To accomplish this, you need to use either of these 2 methods and pass the following parameters to the mentioned URL, via an HTTP POST method:

Method 1 (recommended)

URL: https://<Your_Control Panel_Branded_URL>/servlet/ManageServiceServletForAPI

  • orderid: The Web Services (Email Hosting, Web Hosting, Website Builder), Live Chat Service Order Id that your Customer wants to
    manage. In case of DNS/Email Service, the Order ID of the Product associated with the DNS/Email Service needs to be passed. Based on the orderid,
    the productCategory will be determined.

    Note

    For DNS and Email (Free Email Account [POP/IMAP] and Email Forwarding) that do not have any other Product associated with them, you can
    continue to pass the existing orderid to reach the DNS Management Console and Email Forwarding Management interface respectively.

  • loginid: You need to generate a Login ID, that you need to pass as the value of this parameter for allowing the Customer to
    manage his Order. This can be accomplished by calling the API method generateLoginID in the Customer class. In order to call generateLoginID, you will
    have to pass ipAddress as a parameter. This Login ID generated will be valid for a very short period of time and you should use it immediately upon generating it.

    Note

    While generating the Login ID, you need to use the Username and Password of the Customer, to whom the Order belongs.

  • service-name: This parameter needs to be passed to manage the specified service name. The value of this
    parameter needs to be either:

    • dns: For managing DNS Service.

    • mailfwd: For managing Email Forwarding Service.

    • free_email: For managing Free Email Account Service.

    • mailhosting: For managing Email Hosting Plans.

    • webhosting: For managing Web Hosting Plans.

    • websitebuilder: For managing Website Builder Plans.

This method is the most secure method of allowing your Customers to manage their DNS, Email, Web Hosting, Email Hosting, Live Chat and Website Builder Services, since it does not
expose the Customer's Username and Password in your interface.

If you choose to use this method, then you would need to create an intermediate interface to which you can provide the required parameters, and which in-turn generates a valid URL and redirects your
Customer.

You need to provide orderid and any authentication details (optional) to this interface. This interface would then call the API method
generateLoginID of the Customer class and build a URL with orderid, loginid and service-name as parameters, and then
redirect the Customer to this URL.

Example:

Let us call this interface a servlet named ManageOrderBoxControlPanel (assuming that you are using our JAVA API Kit).

  1. This interface would accept the Web Services (Email Hosting, Web Hosting, Website Builder)/Live Chat Service Order Id or the Order Id of the Product associated with DNS or Email Service as a
    parameter. So, in order to manage a Service, you will call this interface with https://<Your-Server-URL>/ManageOrderBoxControlPanel?orderid=<orderid>.

  2. Now this servlet would need to call the API method generateLoginID of the Customer class like: String loginid = API call to
    generateLoginID(username,password,role,langpref,resellerid,ipAddress);
    where,

    • username: the Username of the Customer, to whom the Order belongs.

    • password: the Password of the Customer, to whom the Order belongs.

    • resellerid: the Reseller Id associated with your Reseller Account. You can find it by clicking the icon at the top right corner within your Reseller Control Panel.

    • role: customer

  3. The final URL to which you would then redirect your Customer to, would look like:

    • For management of Live Chat Services:
      https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?loginid=<loginid>&orderid=<orderid>

    • For management of DNS Service/Email Forwarding Service/Email Hosting/Web Hosting/Website Builder/Free Email Account Service:
      https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?loginid=<loginid>orderid=<orderid>&service-name=<servicename>

Method 2

URL: https://<Your_Control Panel_Branded_URL>/servlet/ManageServiceServletForAPI

  • orderid: The Web Services (Email Hosting, Web Hosting, Website Builder)/Email Hosting/Live Chat Service Order Id that your
    Customer wants to manage. In case of DNS/Email Service, the Order ID of the Product associated with the DNS/Email Service needs to be passed. Based on the orderid,
    the productCategory will be determined.

    Note

    For DNS and Email Forwarding Orders that do not have any other Product associated with them, you can continue to pass the existing orderid to reach the DNS Management
    Console and Email Forwarding Management interface respectively.

  • username: The Username of the Customer, to whom the Order belongs.

  • password: The Password of the Customer, to whom the Order belongs.

  • resellerid: The Reseller Id associated with your Reseller Account. You can find it by clicking the icon at the top right corner within your Reseller Control Panel.

  • service-name: This parameter needs to be passed to manage the specified
    service name.

The disadvantage of using this method is that it is a bit less secure as the Customer Username and Password along with your Reseller Id can be viewed in the source of the page, from where you
post to the ManageServiceServletForAPI servlet.

Note

Do not send the above mentioned as parameters as part of a URL, or else this information will be displayed in your Customer's Browser Address Bar.

Perl API Kit and Integration Guide

Follow the instructions below to begin integration with the API using Perl:

Make sure you have read the General API Integration Instructions first. If you have already integrated the PERL API Kit at your end, read the Change Log first to know what has changed since.

Step 1. Download the API Kit

Note

The SOAP API Kits have been deprecated. We recommend using the HTTP API instead. See details

Step 2. Download the API Documentation

The complete documentation of all classes and methods available in the API can be found in the Docs below. The Docs below are javadocs, but the function names and explanations remain the same for all the platforms and the documentation is self explanatory. We recommend you download the docs and read through them completely once before you integrate your application (updated on 6th September, 2009).

Core_Docs_v3_16.zip

Domains_Docs_v3_16.zip

Hosting_Docs_v3_16.zip

OtherProducts_Docs_v3_16.zip

Instructions to pass parameters to functions using the Perl Kit

Since Perl uses typeless variables you will have to ignore the datatypes presented in the docs. But for assigning values to variable of types other than strings and integers special care will have to be taken. Below is the list of datatypes presented in the API Doc and their usage in Perl.

Java Data Types Assigning values in Perl
String "firstname\@secondname.com"
int 123
HashMap (Datatype for storing name-value pair) {"domain1.com"=>1,"domain2.com"=>1}
Array and Vector (Datatype for storing more than one value) ["ns1.domain.com","ns2.domain.com"]
boolean (Datatype for storing true or false) TRUE / FALSE

Example:

  • For Calling a Function which takes a String datatype and an integer datatype as its paramters


    public int function1(java.lang.String userName, int parentid)

    $result = $obj->function1("firstname\@secondname.com",1);

  • For Calling a Function which takes a HashMap, a String Array and an integer Array as its parameters, where domainHash contains the domainname and the number of years as name value pairs.

    public java.util.HashMap function2(java.util.HashMap domainHash, java.lang.String[] orderby, int[] resellerId)

    $result = $obj->function2({"domain1.com"=>1,"domain2.com"=>2},["column1","column2"],[22,33])

  • For Calling a Function which takes a Vector and a boolean as its parameters


    public java.lang.String function3(java.util.Vector nameServers, boolean add)

    $result = $obj->function3(["ns1.domain.com","ns2.domain.com"],TRUE)

Step 3. Extract the files from the API Kit archive

You should get the following directory & files structure:

cgi-bin/ - Pre-written examples. You can directly run these examples to test API functionality

lib/ - The Perl classfiles, library files and wsdl files that you need to run your application

Step 4. Run the examples

You can run the pre-written examples provided in the examples folder. Note the following steps to do so:

  1. Upload the examples and lib folders to your web server where you run your Perl scripts. Make sure that both these folders are uploaded to the same parent folder.

  2. You must have a recent version of Perl (not newer than SOAP-Lite 0.60) installed on the server.

  3. You must have a Demo account ready the first time. Read the General instructions if you have not yet setup your demo account.

    Additional Information

    General API Integration Instructions

    Note

    The Demo server duplicates all functionality of the live server, however all Domain Names will appear as available on the Demo Server. It does not query the live registry and therefore names which are not available on the live registry will still appear as available on the Demo Server. At times connectivity to the DEMO Registry may be down resulting in errors.

  4. Make the appropriate changes to the constants.cgi file in the cgi-bin folder, by putting in the values for your username, password and parentid. The remaining settings have already been made for you in this file. You may only need to change the path for the wsdl folder if you have uploaded the wsdl folder elsewhere.

  5. The URL to which the call is made is maintained in the config.sh file inside the lib folder. You can make changes to this file and redirect your calls to the appropriate server.

  6. Import and point to note is that you will have to execute the config.sh file from the cgi-bin directory after making any changes in this file to reflect the changes.

  7. Every Example file has a set of functions which you can run.

  8. Once you have modified the appropriate example file, access it over your webserver by putting in your URL such as https://yourserver/examples/html and choose the required function from the links given in the left frame.

Note

In registering/managing any domain name on the demo server always use ns1.onlyfordemo.net and ns2.onlyfordemo.net as your nameservers. ANY OTHER Nameserver will result in an INVALID NAMESERVER error.

Step 5. Understanding Errors

Make sure you have read the General API Integration Instructions to obtain links to the error format and possible error documents.

Additional Information

General API Integration Instructions

Step 6. Writing your own code

After running each example above, if you simply refer to the corresponding .Perl file in the lib folder you will easily be able to figure out the code snippet you need to write in order to make a similar call.

Making an API call to perform any action is a matter of three steps:

  1. Include the appropriate Perl package as below -

    use lib::Customer;

  2. Obtain a pointer to the required Class. This is done by using the code below -

    our $Customer = new Customer($debugMode);

  3. Call the required method on this object. A complete reference of all methods is available in the Docs folder. This can be achieved by using the code below -

    $Customer->wsdlURL($wsdlFile);

    $Customer->StartServices()
    my @param = ($SERVICE_USERNAME, $SERVICE_PASSWORD,
    $SERVICE_ROLE, $SERVICE_LANGPREF, $SERVICE_PARENTID, $customerUserName, $customerPassword,
    $name, $company, $address1, $address2, $address3, $city, $state, $country, $zip,
    $telNoCc, $telNo, $altTelNoCc, $altTelNo, $faxNoCc, $faxNo, $customerLangPref);

Note

You will notice above that EVERY method in the docs takes the same first 5 parameters as -

String SERVICE_USERNAME, String SERVICE_PASSWORD, String SERVICE_ROLE, String SERVICE_LANGPREF, int SERVICE_PARENTID

In the examples these parameters have been put into a single constants file from which they are accessed by including the constants file. These parameters are common no matter which method you call. These parameters mean the
following:

String SERVICE_USERNAME : Your Username

String SERVICE_PASSWORD: Your Password

String SERVICE_ROLE: This will always be a string reseller

String SERVICE_LANGPREF: The 2 letter code of the language in which you wish to receive errors and descriptions - en for English

int SERVICE_PARENTID: The ID of your parent which you can get from your profile section

Step 7. Change the information to Live information when you are ready

Once you have followed the steps above and got the test examples to work successfully, you can duplicate the same code in your live application and replace the Demo Server and Reseller account information with your live username
and password. You will make this change in the config.sh file in the lib folder.

Change Log

Changes in version 3.16

  1. Java Docs updated

  2. Changes related to methods:

    New Methods

    activateMailForwardService() method introduced under the MailFwdOrder class of Domains Kit

    Deprecated Methods

    Methods deprecated under the MailFwdOrder class of Domains Kit:

    • list()

    • add()

    • renew()

    • mod()

    • del()

    • addForward()

    • modForward()

    • delForward()

    • getDetails()

    • getDetailsByDomain()

    • getOrderIdByDomain()

 

Changes in version 3.15

  1. Java Docs updated

  2. Changes related to methods:

    New Methods

    • Domains Kit

      • Methods introduced under the DomOrder class:

        • cancelTransfer()

        • resendTransferAuthorizationMail() (renamed from resendTransferAuthorzationMail())

      • Methods introduced under the DomFwdOrder class:

        • setupDomainFwdService()

        • manageDomainForwardService()

    • Hosting Kit

      enableSSL() method introduced under LinuxHostingOrder and WindowsHostingOrder classes

    Deprecated Methods

    Methods deprecated under the DomFwdOrder class of Domains Kit:

    • getDetails()

    • getDetailsByDomain()

    • renew()

    • manage()

    • deleteService()

    • add()

    • list()

    • mod()

 

Changes in version 3.14

  1. Java Docs updated

  2. Deprecated methods:

    • Core Kit

      • Methods deprecated under the Fund class:

        • getDeletedRefundDetails()

        • listBalancedTransactions()

    • Hosting Kit

      • Methods deprecated under LinuxHostingOrder and WindowsHostingOrder classes:

        • getModPricing()

        • mod()

      • Method deprecated under LinuxHostingSetup and WindowsHostingSetup classes:

        • getHostingParamsDisplayName()

 

Changes in version 3.13

  1. Java Docs updated

  2. Changes related to classes methods:

    New Classes and Methods

    Methods introduced under a new class, DotTel of Domains Kit:

    • modifyWhoisPreference()

    • getCTHLoginDetails()

    Deprecated Methods

    Methods deprecated under the MailHostingOrder class of Hosting Kit:

    • mod()

    • getModPricing()

 

Changes in version 3.12

  1. Java Docs updated

  2. Changes related to methods:

    New Methods

    • Domains Kit

      • setupDNSService() method introduced under the ZoneOrder class

      • Methods introduced under the DomOrder class:

        • restore()

        • resendTransferAuthorzationMail()

    • Other Products Kit

      • renewCertificate() method introduced under the DigitalCertificateOrder class

    Deprecated Methods

    • Domains Kit

      • Methods deprecated under the ZoneOrder class:

        • add()

        • mod()

        • renew()

        • del()

        • list()

        • getDetails()

        • getDetailsByDomain()

        • getOrderIdByDomain()

    • Other Products Kit

      • renew() method deprecated under the DigitalCertificateOrder class

 


.TEL specific changes

If the Registrant of a .TEL domain name is an
Individual, he/she has an option not to have his/her personal information
displayed in the Whois. The Registrant can choose to have this option
enabled/disabled at the time of Registration.

In order to accomplish this, you need to pass
the following information in the extraInfo parameter under the
registerDomain
method of the DomOrder class. The DomOrder
class is included in the Domains Kit:


Key

Value
WhoisType Legal
(default value; applicable if the Registrant is an Organization)
Natural
(applicable if the Registrant is an Individual)
Publish Not
Applicable
N (hides the Contact details in the Whois)



Y (displays the Contact details in the Whois)

However, if the Registrant of a .TEL domain
name is an Organization, then the complete Contact details are displayed in the
Whois. In this case, you need not make any changes to the registerDomain call.

 


Changes in version 3.11

  1. Java Docs updated

  2. Changes related to methods:

    New Methods

    • Other Products Kit

      • modOrderFTPDetails() method under the SiteBuilder class

      • addCertificate() method under the DigitalCertificate class

    • Core Kit

      • delete() method under the Customer class

      • listCurrentActions() and listArchivedActions() methods under the Order class

    Changed Methods

    • DigitalCertificate class of Other Products Kit

      • renew() method (added new parameter approverEmail)

      • reissue() (added new parameters additionalLicenses, orgName, orgStreet, orgCity, orgRegion, orgZip, orgCountry, orgPhone)

    • Customer & Reseller class of Core Kit

      • Changed parameter names of username and passwd to emailAddress and password respectively.

    Removed Methods

    • Hosting Kit

      • fetchAlternateLocationDetailsAndMonthlyCosts() method of MailHostingOrder class

      • fetchAlternateLocationDetailsAndMonthlyCosts() method of LinuxHostingOrder class

      • fetchAlternateLocationDetailsAndMonthlyCosts() method of WindowsHostingOrder class

    Deprecated Methods

    • EntityAction class of Core Kit

      • list()

      • listArchive()

    • DigitalCertificate class of Other Products Kit

      • add()

      • changeDigicertPassword()

      • addAdditionalLicenses()

 

Changes in version 3.10

  1. Java Docs updated

  2. Changes related to classes and methods:

    New Classes and Methods

    Domains Kit
    New Class Name New Method
    ThirdLevelDotUk String invoiceOption
    ThirdLevelDotUk String existingEndTime



    New Parameters introduced in Existing Methods

    Other Products Kit
    Class Name Method Name New Parameters
    EngageOrder renew String invoiceOption
    EngageOrder renew String existingEndTime



    Deprecated Parameters in Methods

    Domains Kit
    Class Name Method Name Deprecated Parameters
    ZoneOrder add "No Of
    Records" in DomainHash



    Deprecated Methods


    Domains Kit
    Class Name Deprecated Method Suggested Class Suggested Method
    DomContact addDefaultContact DomContact addDefaultContacts
    DomContact add DomContact addContact
    DomContact list DomContact listByType
    DomContactExt isValidRegistrantContact DomContactExt isValidContact
    DomOrder transferDomain DomOrder addTransferDomain
    DomOrder add DomOrder registerDomain
    ZoneOrder mod ZoneOrder Functionality not required anymore
    DotEu tradeDomain DotEu trade
    DotEu transferDomain DotEu transfer
    DotEu add DomOrder registerDomain
    Core Kit
    Class Name Deprecated Method Suggested Class Suggested Method
    Customer addCustomer Customer signUp
    Customer modDetails Customer mod
    Reseller addReseller Reseller signUp
    Reseller modDetails Reseller mod
    Reseller addResellerWithStateId Reseller Functionality not required anymore
    OrderSetup getResellerSlabPercentageForProducts OrderSetup Functionality not required anymore
    OrderSetup getCustomerSlabPercentage OrderSetup Functionality not required anymore

 

Changes in version 3.9

  1. Java Docs updated

  2. Changes related to classes and methods:

    The following method in the Domains Kit is deprecated and its use should be discontinued -


    Deprecated method

    Class

    New method to be used
         
    isValidRegistrantContact DomContactExt isValidContact

 

Changes in version 3.8

  1. Java Docs updated

  2. Changes related to classes and methods:

    • The following changes have been introduced under the DotEu class within the Domains Kit -

      • New methods

        • trade

        • transfer

      • Deprecated methods

        • tradeDomain

        • transferDomain

    • The following new methods have been introduced under DigitalCertificateOrder class within the Other
      Products Kit:

      • enrollForThawteCertificate

      • reissue

      • renew

      • checkDigitalCertificateStatus

      • del

      • cancelDigicertOrder

      • changeDigicertPassword

      • addAdditionalLicenses

      • getDetails

      • getDetailsByDomain

      • getOrderIdByDomain

 

Changes in version 3.7

  1. Java Docs updated

  2. Changes related to classes and methods:

    Some old parameters have been removed and new parameters introduced in their place under the following methods  -



    LinuxHostingOrder Class
    Method Old Parameter New Parameters
    add Hashtable
    orderParams
    String packageKey*,
    boolean ssl#
    mod Hashtable
    orderParams
    String packagekey*,
    boolean ssl#,
    int excessBandwidth##
    getMonthlyCostAndValidate Hashtable
    orderParams
    String packageKey*,
    boolean ssl#,
    int execessBandwidth##
    getModPricing Hashtable orderParams String
    packageKey*, boolean ssl#,
    int execessBandwidth##

    WindowsHostingOrder Class
    Method
    Old Parameter
    New Parameters
    add Hashtable
    orderParams
    String packageKey*,
    boolean ssl#
    mod Hashtable
    orderParams
    String packagekey*,
    boolean ssl#,
    int excessBandwidth##
    getMonthlyCostAndValidate Hashtable
    orderParams
    String packageKey*,
    boolean ssl#,
    int execessBandwidth##
    getModPricing Hashtable
    orderParams
    String
    packageKey*, boolean ssl#,
    int execessBandwidth##


    MailHostingOrder Class
    Method
    Old Parameter
    New Parameters
    add Hashtable
    orderParams
    String packageKey*
    mod Hashtable
    orderHash
    String packagekey*,
    int additionalMailBoxes**
    getMonthlyCostAndValidate Hashtable
    orderParams
    String packageKey*,
    int additionalMailBoxes**
    getModPricing Hashtable
    orderParams
    String
    packageKey*, int
    additionalMailBoxes**


    SiteBuilder Class
    Method Old Parameter New Parameters
    mod

    Hashtable
    orderParams

    String packageKey*
    getMonthlyCostAndValidate

    Hashtable
    orderParams

    String packageKey*

    Note
    • *packageKey will be the Identifier Key of the Plan (plan1, plan2, plan3, plan4) for which the Order needs to be added/modified.

    • #ssl will be true or false depending whether the user wants Dedicated IP / SSL for the Order placed.

    • ##excessBandwidth is the Bandwidth which the user wants over and above the Bandwidth of the Order's current plan.

    • **additionalMailBoxes is the number of additional mail boxes over and above the existing ones in blocks of 100 accounts.

  3. The following classes and their methods are removed:

    • LinuxHostingPlanOnlyOrder

    • WindowsHostingPlanOnlyOrder

    • MailHostingPlanOnlyOrder

    • SiteBuilderPro

  4. The SiteBuilderLite class has been renamed to SiteBuilder.

  5. Two new methods, mod and signUp, have been introduced under the Reseller and Customer classes.

  6. Code for registerDomain method in PERL Domains Kit has been modified.

  7. The return type of the ListByType method of DomContact class in the Domains Kit has been changed to Hashtable from Vector.

 

Changes in version 3.6

  1. Java Docs updated

  2. Changes related to classes and methods:

    • New methods have been added in the Core Kit under the following class:

      • getProductMetadata - Product class

    • New methods have been added in the Domains Kit under the following classes:

      • getDefaultContactId - DomContactExt class

      • listByType - DomContact class

      • addTransferDomain - DomOrder class

      • changePrivacyProtectionStatus - DomOrder class

      • registerDomain - DomOrder class

    • Changes to the DomOrder class in Domains Kit:

      • Privacy Protection Handling is added in the bulkAdd and bulkAddTransferDomain methods.

      • The ns parameter has been removed from the validateDomainTransferParams method.

    • The following methods in the Domains Kit are deprecated and their use
      should be discontinued:


      Deprecated method
      Class New
      method to be used
           
      add DomContact addContact
      addDefaultContact DomContact addDefaultContacts
      list DomContact listByType
      add DomOrder registerDomain
      transferDomain DomOrder addTransferDomain
      transferDomainWithoutValidation DomOrder addTransferDomain
      addTransferDomainWithoutvalidation DomOrder

      addTransferDomain

      add DotEu registerDomain in DomOrder class
      Note

      While these methods are currently available, they are no longer supported and may be discontinued in the near future.

    • New methods have been added in the Hosting Kit under the following class:

      • getHostingMetaData - WebHostingOrderData class

    • Changes to classes in the Hosting Kit:

      The invoiceOption parameter has been added to the add method of
      MailHostingPlanOnlyOrder, WindowsHostingPlanOnlyOrder and
      LinuxHostingPlanOnlyOrder classes

Changes in version 3.5

  1. Java Docs updated

  2. Changes related to classes and functions:

    • New functions have been added in the Core Kit under the following classes:

      • getList - Country class

      • getStateListForCountry - Country class

      • getDetails - Order class

      • addResellerWithStateId - Reseller class

    • An extra option called Supersite is added in the getDetails function of the Reseller class in the Core Kit.

    • A new class LegalAgreement is added with the following methods under the Core Kit:

      • getRegistrantAgreement

      • getProductCategory

      • getAgreement

      • getAllAgreements

    • A new function has been added in the Domains Kit under the following class:

      • addCoopContact - DotCoopContact class

    • The following functions in the DomOrder class in the Domains Kit are changed to show the Invoice options also:

      • validateDomainRegistrationParams

      • validateDomainTransferParams

      • addWithoutValidation

Changes in version 3.4

  1. Java Docs Updated

  2. New Classes introduced in all Kits:

    • Core Kit

      • TaxService

        • getApplicableTaxes

        • getHashedTaxRules

    • Domains Kit

      • DotEu

        • getEUCountryList

        • tradeDomain

        • transferDomain

        • add

        • isEUCountry

      • DotEuContact

        • mod

        • add

        • addEuDefaultContact

      • DomOrder

        • validateDomainRegistrationParams

        • validateDomainTransferParams

        • addTransferDomainWithoutvalidation

        • addWithoutValidation

    • Hosting Kit

      • WindowsHostingPlanOnlyOrder

        • getDetails

        • getDetailsByDomain

        • getOrderIdByDomain

        • add

        • mod

        • renew

        • del

        • getMonthlyCostAndValidate

        • getModPricing

        • getDeletionRefundAmount

      • LinuxHostingPlanOnlyOrder

        • getDetails

        • getDetailsByDomain

        • getOrderIdByDomain

        • add

        • mod

        • renew

        • del

        • getMonthlyCostAndValidate

        • getModPricing

        • getDeletionRefundAmount

      • MailHostingPlanOnlyOrder

        • getDetails

        • getDetailsByDomain

        • getOrderIdByDomain

        • add

        • mod

        • renew

        • del

        • getMonthlyCostAndValidate

        • getModPricing

        • getDeletionRefundAmount

        • list

      • MailHostingSetup

        • getHostingKeyDisplayName

        • getHostingParamsDisplayName

        • getPricingKeyPricingParamMap

      • WindowsHostingSetup

        • getHostingKeyDisplayName

        • getHostingParamsDisplayName

        • getPricingKeyPricingParamMap

      • LinuxHostingSetup

        • getHostingKeyDisplayName

        • getHostingParamsDisplayName

        • getPricingKeyPricingParamMap

    • Other Products Kit

      • DigitalCertificateOrder

        • add

        • getCertPrice

      • SiteBuilderSetup

        • getPricingKeyPricingParamMap

        • EngageSetup

          • getPricingKeyPricingParamMap

Changes in version 3.3

  • 3 new functions have been added in the Core Kit under the following classes:

    • authenticateCustomerId - Customer class

    • login - Customer class

    • getOrderIdByDomainAndProductCategory - Order class

  • Bug Fix - A minor Java Script problem was causing the frame links in the examples to not work in some browsers like Mozilla and Opera.

Changes in version 3.2.1

  • WSDL Endpoint changed

Changes in version 3.2

  • New methods added viz. Order.removeCustomerLock, Order.getLockList

Changes in version 3.1

  • Minor bugs in WSDL files fixed.

Version 3.0 Released

  • Extensive changes made. Please download the kit and read the appropriate Javadocs for details.

Changes in version 2.6

  • Added the method Customer.delete() which allows you to delete a Customer

  • Added the method DomOrder.cancelTransferRequest() which allows you to cancel the transfer-in request for a domain name

  • Added the method Order.sendRfa() which allows you to re/send the email asking for transfer-in approval for domain names.



Changes in version 2.5

  • Bug fix in Modify Customer Details and Modify Contact Details forms

  • More details in the Javadocs for DomOrder.getDetails()

  • Link to new Demo Server added.

Version 2.3

  • Perl API KIT added

.NET API Kit and Integration Guide

Follow the instructions below to begin integration with the API using .NET:

Make sure you have read the General API Integration Instructions first. If you have already integrated the .NET API Kit at your end, read the Change Log first to know what has changed since.

Step 1. Download the API Kit

Note

The SOAP API Kits have been deprecated. We recommend using the HTTP API instead. See details

Step 2. Download the API Documentation

The complete documentation of all classes and methods available in the API can be found in the Docs below. The Docs below are javadocs, but the function names and explanations remain the same for all
the platforms and the documentation is self explanatory. We recommend you download the docs and read through them completely once before you integrate your application (updated on 6th
September, 2009)
.

Core_Docs_v3_16.zip

Domains_Docs_v3_16.zip

Hosting_Docs_v3_16.zip

OtherProducts_Docs_v3_16.zip

Step 3. Install the API Kit

There are two ways by which you may install the API Kit on your computer:

Option 1 - Setup Application

We recommend that you download, unzip and run the setup file. First, however, please be sure that you have administrator privileges to install applications on the computer. If you're hosting your website
with a third-party provider and do not have the rights to install applications, then you will not be able to use the setup application to install the kit. Therefore, you may manually install and use the required
API files from our compressed ZIP file option (Refer to Option 2 below).

The setup application will perform the following tasks:

  1. A .NET dll containing the kit, and the relevant documentation, will be placed inside your Program Files folder; by default, the path would
    be C:\Program Files\. Therefore, you should be able to find the DLL and the documentation corresponding to your kit. Please ensure that you have the .NET runtime installed before you attempt to use the API kit.

  2. Relevant shortcuts will be placed in your start menu.

  3. If you have Microsoft Internet Information Server (IIS) version 5.0 or greater installed, the setup file will create a virtual directory named as
    OrderBoxCoreExamples, OrderBoxDomainsExamples,
    OrderBoxHostingExamples, OrderBoxOtherProductsExamples in your Default Web Site. The setup file allows you to
    give the virtual directory any name of your choice. This virtual directory contains a Visual Studio .NET project called OrderBoxCoreExamples ,
    OrderBoxDomainsExamples, OrderBoxHostingExamples,
    OrderBoxOtherProductsExamples, which illustrates every function provided in the OrderBox API. You may run the examples by either by:

Option 2 - Compressed ZIP File

Download the zip file and extract the files to any temporary folder. The temporary folder will now contain the following subfolders:

  1. OrderBoxCoreExamples , OrderBoxDomainsExamples, OrderBoxHostingExamples,
    OrderBoxOtherProductsExamples - The folder contains the example files to illustrate every method in the kit.

  2. bin - This folder contains the actual kit DLL file. This is a .NET DLL, and requires the .NET runtime to be pre-installed, for use.

Installing the examples on your own computer:

  1. Create the Examples folder (OrderBoxCoreExamples , OrderBoxDomainsExamples, OrderBoxHostingExamples,
    OrderBoxOtherProductsExamples) inside the root
    of any website configured in IIS, on your computer. IIS contains a default website called Default Web Site, having it's root folder set to c:\Inetpub\wwwroot. If you
    have a default installation of IIS, you would create a subfolder called examples inside that root folder. Please note that you may name the examples directory as you please, you are not restricted to the name OrderBoxCoreExamples ,
    OrderBoxDomainsExamples, OrderBoxHostingExamples, OrderBoxOtherProductsExamples.

  2. Open the IIS management console by navigating to Start > Programs > Administrative Tools >
    Internet Information Services.

  3. Now, we need to create an Application Root for the examples folder. This can be accomplished by opening the properties window for that directory and clicking
    the Create button.

If you successfully completed the above steps, you may open your browser and point it to https://localhost/examples (if you gave your examples folder some other name, replace the last word of the URL with that name).

Step 4. Run the examples

Please note first that the ASP.NET examples are provided solely to help illustrate usage of the ASP.NET Kit. You may use the example files directly, or simply use them as a reference project while developing your application to interface with the API.

Note

IIS 5.0 and the .NET runtime MUST be installed on your machine, BEFORE you run the kit setup file.

After you've installed the ASP.NET examples, open your browser, and point it to https://localhost/your-examples-folder (you may use the name given to the examples folder to replace examples in the preceding url). This shall open the ASP.NET examples webpage, which is divided into three frames:

  • The frame on the top allows you to mention the Service URL, your Reseller Username, your Password, ParentID, Language Preference, Role, Debug Mode to make API calls independent of the credentials provided in the APIConstants.vb file. This frame also provides you a checkbox to enable/disable the credentials of this frame. That is, if the checkbox is not selected the APIConstants.vb file credentials will be used to make the API call.

  • The lower left frame contains a list of links to pages that illustrate the use of each method in the API. When you click a link, it's corresponding page is displayed in the right hand side frame. You may test the functions by putting in the call parameters in the page.

Step 5. Understanding Errors

Make sure you have read the General API Integration Instructions to obtain links to the error format and possible error documents.

Additional Information

General API Integration Instructions

Step 6. Writing your own code

The API classes exist within the namespace OrderBoxCoreLib , OrderBoxDomainsLib, OrderBoxHostingLib, OrderBoxOtherProductsLib. The class named "Properties", contains static variables useful for debugging, and changing the SOAP End Point.

The following are valid end points for the OrderBox Demo Server for API Kits ver 3.x and above:

Note

Following are valid end points for the OrderBox Demo Server for older API Kits:

The following are valid end points for the OrderBox Live Server:

Note

Following are valid end points for the OrderBox Live Server for older API Kits:

Example:

To test the examples, you must first create an account on the Demo server. To use the Customer webservices of the API, instantiate the customer object as demonstrated below. If at any time the SOAP end point must be changed to some other url, you may simply put the new SOAP end point into this variable.

Properties.Url = "https://soap-end-point";

The following code instantiates the Customer object. You may now use it's methods to call various OrderBox API functions. These are SOAP calls, that will be made to the SOAP End Point specified by the Propeties.Url
variable.

Customer oCustomer = new Customer ();

To illustrate the use of this object, we shall take the example of a method called getCustomerId. Examine the code snippet below. It uses an object of the Customer class to request the id of a specified username.


int result = 0; 



// First we make sure that our SOAP End Point is pointing to the correct resource.

Properties.Url = "https://api.onlyfordemo.net/anacreon/servlet/APIv3-XML";



// The examples use a class called Constants, containing static properties that hold your credentials. You may set these properties once, and later in the file simply pass them to the method calls as required. The values set below are simply examples, and must be replaced with your own credentials.

Constants.Username = username@domain.com;// Your username goes here.

Constants.Password = your-password;// Your password goes here.

Constants.Role = reseller;// Your role goes here.

Constants.LangPref = en;// Your language preference goes here.

Constants.ParentID = 1;// Your parent id goes here.



// Since we wish to view the soap request and response ...

Properties.Debug = true;



// Next we instantiate an object of the Customer class.

Customer oCustomer = new Customer ();



// We then use this customer object to request the id for a specified username.

result = oCustomer.getCustomerId
(ApiConstants.SERVICE_USERNAME,

ApiConstants.SERVICE_PASSWORD,

ApiConstants.SERVICE_ROLE,

ApiConstants.SERVICE_LANGPREF,

ApiConstants.SERVICE_PARENTID,

"username");



// Now we display the soap request.

Console.WriteLine (Properties.getLastRequest); Console.WriteLine ();



// Then we display the soap response.

Console.WriteLine (Properties.getLastResponse); Console.WriteLine ();



// Lastly we display the result.

Console.WriteLine (result);

The above code accepts authentication details and a username, and returns an integer value, which is the id corresponding to the username passed. The last parameter of the getCustomerId method is the username for which we requested an id. This id was returned into the integer variable result.

Please note the first five parameters of this method call. They consist of the username, password, role, language preference, and parent id respectively, of the individual calling the method. For the examples, you may make a demo account on the demo server, and pass the username, password, role, language preference and parent id from your demo account to this method call. These are the first five parameters that are passed to every API call that is undertaken. Please make sure that you pass accurate details for these parameters. If you do not, your method call will be unsuccessful.

Note

In registering/managing any domain name on the demo server always use ns1.onlyfordemo.net and ns2.onlyfordemo.net as your nameservers. ANY OTHER Nameserver will result in an INVALID NAMESERVER error.

Step 7. Change the information to Live information when you are ready

When you have got the examples working correctly, you may set the value of Properties.Url to one of the live URL's, and pass your own authentication details when making API calls.

Change Log

Changes in version 3.16

  1. Java Docs updated

  2. Changes related to methods:

    New Methods

    activateMailForwardService() method introduced under the MailFwdOrder class of Domains Kit

    Deprecated Methods

    Methods deprecated under the MailFwdOrder class of Domains Kit:

    • list()

    • add()

    • renew()

    • mod()

    • del()

    • addForward()

    • modForward()

    • delForward()

    • getDetails()

    • getDetailsByDomain()

    • getOrderIdByDomain()

 

Changes in version 3.15

  1. Java Docs updated

  2. Changes related to methods:

    New Methods

    • Domains Kit

      • Methods introduced under the DomOrder class:

        • cancelTransfer()

        • resendTransferAuthorizationMail() (renamed from resendTransferAuthorzationMail())

      • Methods introduced under the DomFwdOrder class:

        • setupDomainFwdService()

        • manageDomainForwardService()

    • Hosting Kit

      enableSSL() method introduced under LinuxHostingOrder and WindowsHostingOrder classes

    Deprecated Methods

    Methods deprecated under the DomFwdOrder class of Domains Kit:

    • getDetails()

    • getDetailsByDomain()

    • renew()

    • manage()

    • deleteService()

    • add()

    • list()

    • mod()

 

Changes in version 3.14

  1. Java Docs updated

  2. Deprecated methods:

    • Core Kit

      • Methods deprecated under the Fund class:

        • getDeletedRefundDetails()

        • listBalancedTransactions()

    • Hosting Kit

      • Methods deprecated under LinuxHostingOrder and WindowsHostingOrder classes:

        • getModPricing()

        • mod()

      • Method deprecated under LinuxHostingSetup and WindowsHostingSetup classes:

        • getHostingParamsDisplayName()

 

Changes in version 3.13

  1. Java Docs updated

  2. Changes related to classes & methods:

    New Classes and Methods

    Methods introduced under a new class, DotTel of Domains Kit:

    • modifyWhoisPreference()

    • getCTHLoginDetails()

    Deprecated Methods

    Methods deprecated under the MailHostingOrder class of Hosting Kit:

    • mod()

    • getModPricing()

 

Changes in version 3.12

  1. Java Docs updated

  2. Changes related to methods:

    New Methods

    • Domains Kit

      • setupDNSService() method introduced under the ZoneOrder class

      • Methods introduced under the DomOrder class:

        • restore()

        • resendTransferAuthorzationMail()

    • Other Products Kit

      • renewCertificate() method introduced under the DigitalCertificateOrder class

    Deprecated Methods

    • Domains Kit

      • Methods deprecated under the ZoneOrder class:

        • add()

        • mod()

        • renew()

        • del()

        • list()

        • getDetails()

        • getDetailsByDomain()

        • getOrderIdByDomain()

    • Other Products Kit

      • renew() method deprecated under the DigitalCertificateOrder class

 


.TEL specific changes

If the Registrant of a .TEL domain name is an Individual, he/she has an option not to have his/her personal information displayed in the Whois. The Registrant can choose to have this option enabled/disabled at the time of Registration.

In order to accomplish this, you need to pass the following information in the extraInfo parameter under the registerDomain method of the DomOrder class. The DomOrder class is included in the Domains Kit:

Key Value
WhoisType Legal (default value; applicable if the Registrant is an Organization) Natural (applicable if the Registrant is an Individual)
Publish Not Applicable N (hides the Contact details in the Whois)


Y (displays the Contact details in the Whois)

However, if the Registrant of a .TEL domain name is an Organization, then the complete Contact details are displayed in the Whois. In this case, you need not make any changes to the registerDomain call.

 


Changes in version 3.11

  1. Java Docs updated

  2. Changes related to methods:

    New Methods

    • Other Products Kit

      • modOrderFTPDetails() methos under the SiteBuilder class

      • addCertificate() method under the DigitalCertificate class

    • Core Kit

      • delete() method under the Customer class

      • listCurrentActions() and listArchivedActions() methods under the Order class

    Changed Methods

    • DigitalCertificate class of Other Products Kit

      • renew() method (added new parameter approverEmail)

      • reissue() (added new parameters additionalLicenses,
        orgName, orgStreet, orgCity, orgRegion, orgZip, orgCountry, orgPhone)

    • Customer & Reseller class of Core Kit

      • Changed parameter names of username and passwd to emailAddress and password respectively.

    Removed Methods

    • Hosting Kit

      • fetchAlternateLocationDetailsAndMonthlyCosts() method of MailHostingOrder class

      • fetchAlternateLocationDetailsAndMonthlyCosts() method of LinuxHostingOrder class

      • fetchAlternateLocationDetailsAndMonthlyCosts() method of WindowsHostingOrder class

    Deprecated Methods

    • EntityAction class of Core Kit

      • list()

      • listArchive()

    • DigitalCertificate class of Other Products Kit

      • add()

      • changeDigicertPassword()

      • addAdditionalLicenses()

 

Changes in version 3.10

  1. Java Docs updated

  2. Changes related to classes and methods:

    New Classes and Methods

    Domains Kit
    New Class Name New Method
    ThirdLevelDotUk String invoiceOption
    ThirdLevelDotUk String existingEndTime



    New Parameters introduced in Existing Methods

    Other Products Kit
    Class Name Method Name New Parameters
    EngageOrder renew String invoiceOption
    EngageOrder renew String existingEndTime


    Deprecated Parameters in Methods

    Domains Kit
    Class Name Method Name Deprecated Parameters
    ZoneOrder add "No Of Records" in DomainHash



    Deprecated Methods


    Domains Kit
    Class Name Deprecated Method Suggested Class Suggested Method
    DomContact addDefaultContact DomContact addDefaultContacts
    DomContact add DomContact addContact
    DomContact list DomContact listByType
    DomContactExt isValidRegistrantContact DomContactExt isValidContact
    DomOrder transferDomain DomOrder addTransferDomain
    DomOrder add DomOrder registerDomain
    ZoneOrder mod ZoneOrder Functionality not
    required anymore
    DotEu tradeDomain DotEu trade
    DotEu transferDomain DotEu transfer
    DotEu add DomOrder registerDomain
    Core Kit
    Class Name Deprecated Method Suggested Class Suggested Method
    Customer addCustomer Customer signUp
    Customer modDetails Customer mod
    Reseller addReseller Reseller signUp
    Reseller modDetails Reseller mod
    Reseller  addResellerWithStateId Reseller Functionality not required anymore
    OrderSetup getResellerSlabPercentageForProducts OrderSetup Functionality not required anymore
    OrderSetup getCustomerSlabPercentage OrderSetup Functionality not required anymore

 

Changes in version 3.9

  1. Java Docs updated

  2. Changes related to classes and methods:

    The following method in the Domains Kit is deprecated and its use should be discontinued -

    Deprecated method Class New method to be used
         
    isValidRegistrantContact DomContactExt isValidContact

 

Changes in version 3.8

  1. Java Docs updated

  2. Changes related to classes and methods:

    • The following changes have been introduced under the DotEu class within the Domains Kit -

      • New methods

        • trade

        • transfer

      • Deprecated methods

        • tradeDomain

        • transferDomain

    • The following new methods have been introduced under DigitalCertificateOrder class within the Other Products Kit -

      • enrollForThawteCertificate

      • reissue

      • renew

      • checkDigitalCertificateStatus

      • del

      • cancelDigicertOrder

      • changeDigicertPassword

      • addAdditionalLicenses

      • getDetails

      • getDetailsByDomain

      • getOrderIdByDomain

 

Changes in version 3.7

  1. Java Docs updated

  2. Changes related to classes and methods:

    Some old parameters have been removed and new parameters introduced in their place under the following methods -


    LinuxHostingOrder Class
    Method Old Parameter New Parameters
    add Hashtable orderParams String packageKey*,
    boolean ssl#
    mod Hashtable orderParams String packagekey*,
    boolean ssl#,
    int excessBandwidth##
    getMonthlyCostAndValidate Hashtable orderParams String packageKey*,
    boolean ssl#,
    int execessBandwidth##
    getModPricing Hashtable orderParams String packageKey*, boolean ssl#,

    int execessBandwidth##
    WindowsHostingOrder Class
    Method Old Parameter New Parameters
    add Hashtable orderParams String packageKey*,
    boolean ssl#
    mod Hashtable
    orderParams
    String packagekey*,
    boolean ssl#,
    int excessBandwidth##
    getMonthlyCostAndValidate Hashtable orderParams String packageKey*,
    boolean ssl#,
    int execessBandwidth##
    getModPricing Hashtable orderParams String packageKey*, boolean ssl#,

    int execessBandwidth##

    MailHostingOrder Class
    Method Old Parameter New Parameters
    add Hashtable orderParams String packageKey*
    mod Hashtable orderHash String packagekey*,
    int additionalMailBoxes**
    getMonthlyCostAndValidate Hashtable orderParams String packageKey*,
    int additionalMailBoxes**
    getModPricing Hashtable orderParams String packageKey*, int
    additionalMailBoxes**

    SiteBuilder Class
    Method Old Parameter New Parameters
    mod Hashtable orderParams String packageKey*
    getMonthlyCostAndValidate Hashtable orderParams String packageKey*

    Note
    • *packageKey will be the Identifier Key of the Plan (plan1, plan2, plan3, plan4) for which the Order needs to be added/modified.

    • # ssl will be true or false depending whether the user wants Dedicated IP / SSL for the Order placed.

    • ## excessBandwidth is the Bandwidth which the user wants over and above the Bandwidth of the Order's current plan.

    • ** additionalMailBoxes is the number of additional mail boxes over and above the existing ones in blocks of 100 accounts.

  3. The following classes and their methods are removed:

    • LinuxHostingPlanOnlyOrder

    • WindowsHostingPlanOnlyOrder

    • MailHostingPlanOnlyOrder

    • SiteBuilderPro

  4. The SiteBuilderLite class has been renamed to SiteBuilder.

  5. Two new methods, mod and signUp, have been introduced under the Reseller and Customer classes.

  6. The return type of the ListByType method of DomContact class in the Domains Kit has been changed to Hashtable from Vector.

 

Changes in version 3.6

  1. Java Docs updated

  2. Changes related to classes and methods:

    • New methods have been added in the Core Kit under the following class:

      • getProductMetadata - Product class

      • New methods have been added in the Domains Kit under the following classes:

        • getDefaultContactId - DomContactExt class

        • listByType - DomContact class

        • addTransferDomain - DomOrder class

        • changePrivacyProtectionStatus - DomOrder class

        • registerDomain - DomOrder class

      • Changes to the DomOrder class in Domains Kit:

        • Privacy Protection Handling is added in the bulkAdd and bulkAddTransferDomain methods.

        • The ns parameter has been removed from the validateDomainTransferParams method.

      • The following methods in the Domains Kit are deprecated and their use should be discontinued:

        Deprecated method Class New method to be used
             
        add DomContact addContact
        addDefaultContact DomContact addDefaultContacts
        list DomContact listByType
        add DomOrder registerDomain
        transferDomain DomOrder addTransferDomain
        transferDomainWithoutValidation DomOrder addTransferDomain
        addTransferDomainWithoutvalidation DomOrder addTransferDomain
        add DotEu registerDomain in DomOrder class
        Note

        While these methods are currently available, they are no longer supported and may be discontinued in the near future.

      • New methods have been added in the Hosting Kit under the following class:

        • getHostingMetaData - WebHostingOrderData class

      • Changes to classes in the Hosting Kit:

        The invoiceOption parameter has been added to the add method of MailHostingPlanOnlyOrder, WindowsHostingPlanOnlyOrder and LinuxHostingPlanOnlyOrder classes

       

    Changes in version 3.5

    1. Java Docs updated

    2. Changes related to classes and functions:

      • New functions have been added in the Core Kit under the following classes:

        • getList - Country class

        • getStateListForCountry - Country class

        • getDetails - Order class

        • addResellerWithStateId - Reseller class

      • An extra option called Supersite is added in the getDetails function of the Reseller class in the Core Kit.

      • A new class LegalAgreement is added with the following methods under the Core Kit:

        • getRegistrantAgreement

        • getProductCategory

        • getAgreement

        • getAllAgreements

      • A new function has been added in the Domains Kit under the following class:

        addCoopContact - DotCoopContact class

      • The following functions in the DomOrder class in the Domains Kit are changed to show the Invoice options also:

        • validateDomainRegistrationParams

        • validateDomainTransferParams

        • addWithoutValidation

       

    Changes in version 3.4

    1. Java Docs Updated

    2. COM visible interfaces have been added for those who use ASP or VB, so that they are also able to use our DLLs.

    3. New Classes introduced in all Kits:

      • Core Kit

        • TaxService

          • getApplicableTaxes

          • getHashedTaxRules

      • Domains Kit

        • DotEu

          • getEUCountryList

          • tradeDomain

          • transferDomain

          • add

          • isEUCountry

        • DotEuContact

          • mod

          • add

          • addEuDefaultContact

        • DomOrder

          • validateDomainRegistrationParams

          • validateDomainTransferParams

          • addTransferDomainWithoutvalidation

          • addWithoutValidation

      • Hosting Kit

        • WindowsHostingPlanOnlyOrder

          • getDetails

          • getDetailsByDomain

          • getOrderIdByDomain

          • add

          • mod

          • renew

          • del

          • getMonthlyCostAndValidate

          • getModPricing

          • getDeletionRefundAmount

        • LinuxHostingPlanOnlyOrder

          • getDetails

          • getDetailsByDomain

          • getOrderIdByDomain

          • add

          • mod

          • renew

          • del

          • getMonthlyCostAndValidate

          • getModPricing

          • getDeletionRefundAmount

        • MailHostingPlanOnlyOrder

          • getDetails

          • getDetailsByDomain

          • getOrderIdByDomain

          • add

          • mod

          • renew

          • del

          • getMonthlyCostAndValidate

          • getModPricing

          • getDeletionRefundAmount

          • list

        • MailHostingSetup

          • getHostingKeyDisplayName

          • getHostingParamsDisplayName

          • getPricingKeyPricingParamMap

        • WindowsHostingSetup

          • getHostingKeyDisplayName

          • getHostingParamsDisplayName

          • getPricingKeyPricingParamMap

        • LinuxHostingSetup

          • getHostingKeyDisplayName

          • getHostingParamsDisplayName

          • getPricingKeyPricingParamMap

      • Other Products Kit

        • DigitalCertificateOrder

          • add

          • getCertPrice

        • SiteBuilderSetup

          • getPricingKeyPricingParamMap

          • EngageSetup

            • getPricingKeyPricingParamMap

    Changes in version 3.3

    • All the DLLs have been modified to allow partially trusted callers to use it.

    • 3 new functions have been added in the Core Kit under the following classes:

      • authenticateCustomerId - Customer class

      • login - Customer class

      • getOrderIdByDomainAndProductCategory - Order class

    • Bug Fix - A minor Java Script problem was causing the frame links in the examples to not work in some browsers like Mozilla and Opera.

    Changes in version 3.2

    • New methods added viz. Order.removeCustomerLock, Order.getLockList

    • The testing form provided now has a third frame which accepts the standard parameters passed in every call. If you set these parameters from the form, you can make test calls independent of the settings in the properties/constants file.

    • We've added 'Strong Names' to the kit.

    Changes in version 3.0

    • Extensive changes made. Please download the kit and read the appropriate Javadocs for details.

    Changes in version 2.6

    • Added the method Customer.delete() which allows you to delete a Customer

    • Added the method DomOrder.cancelTransferRequest() which allows you to cancel the transfer-in request for a domain name

    • Added the method Order.sendRfa() which allows you to re/send the email asking for transfer-in approval for domain names.

    Changes in version 2.5.3

    • Bug fix: DomainContact.delete() used to throw an "Invalid Cast from string''" exception due to an incorrectly coded return type. This has been fixed.

    Changes in version 2.5.2

    • Bug fix: It is now possible to view the XML sent and received.

    Changes in version 2.5.1

    • Bug fix: The Setup.ini file was missing

    Changes in version 2.5

    • Bug fix in Modify Customer Details and Modify Contact Details forms

    • More details in the Javadocs for DomOrder.getDetails()

    • Link to new Demo Server added.

    • Move Service functionality added in API

    • Add Funds functionality for both Sub-Resellers and Customers also added.

    • Domain Forwarding, Mail Forwarding, Managed DNS Products now available through the API.

    Changes in version 1.5

    • Timeouts in the .NET API Kit when making some method calls are fixed.

    • The .NET API Kit is now strongly named.

    Changes in version 1.4

    • Hashtable being passed by the Examples kit, to the domainHash parameter of the renewDomain method, in the Domain class, is now in the correct format.

    Changes in version 1.2

    • Modified the default soap end point. It now points to the demo server.

    • Fixed Api Kit dll linkages in the Examples solution.