Changes in version 3.10
Java Docs updated
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 |
| Domains Kit | ||
| Class Name | Method Name | Deprecated Parameters |
| ZoneOrder | add | “No Of Records” in DomainHash |
| 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
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
Java Docs updated
Changes related to classes and methods:
The following changes have been introduced under the DotEu class within the Domains Kit -
The following new methods have been introduced under DigitalCertificateOrder class within the Other Products Kit -
The following new methods have been introduced under DigitalCertificateOrder class within the Other Products Kit -
The following new methods have been introduced under DigitalCertificateOrder class within the Other Products Kit -
Changes in version 3.7
Java Docs updated
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.
Changes in version 3.6
Java Docs updated
Changes related to classes and methods:
getProductMetadata – Product class
| 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 |
While these methods are currently available, they are no longer supported and may be discontinued in the near future.
Changes in version 3.5
Java Docs updated
Changes related to classes and functions:
getList – Country class
getStateListForCountry – Country class
getDetails – Order class
addResellerWithStateId – Reseller class
Changes in version 3.4
Java Docs Updated
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
Short tags have been removed from the response.php file.
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
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.
Changes in version 3.1
Minor bugs in WSDL files fixed.
Changes in version
Extensive changes made. Please download the kit and read the appropriate Javadocs for details.
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.
Bug fix in Domain.BulkLockOrder().
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.
Removed Function Overloading
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.
DomUsContact class
New utility class Response class is introduced, which can be used for formatted output. The characteristics of the Response class are listed below:
listContact() function
getCustomerAvailableBalance() fuction
getCustomerId() function
Tags: Api, Core Kit, Customer Signup, Deprecated Methods, DNS, Java, Java Docs, Kit Class, nexusCategory facility, Parameters, Php, Registerdomain, SSL
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.
Reference:
General API Integration Instructions >>
Change Log >>
Step 1. Download the API Kit
Click the link below to download the relevant API kits (updated on 6th March, 2008).
Option 1 – Setup Application
NET_Core_Setup_v3_10.zip
NET_Domains_Setup_v3_10.zip
NET_Hosting_Setup_v3_10.zip
NET_OtherProducts_Setup_v3_10.zip
Option 2 – Compressed ZIP File
NET_CoreExamples_v3_10.zip
NET_DomainsExamples_v3_10.zip
NET_HostingExamples_v3_10.zip
NET_OtherProductsExamples_v3_10.zip
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 March, 2008).
Core_Docs_v3_10.zip
Domains_Docs_v3_10.zip (updated on 1st April, 2008)
Hosting_Docs_v3_10.zip
OtherProducts_Docs_v3_10.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:
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.
Relevant shortcuts will be placed in your start menu.
If you have Microsoft Internet Information Server version 5.0 or greater (IIS) 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:
Opening it in Visual Studio.Net and pressing the F5 key, or
Visiting the url http://localhost/examples/ in your browser.
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:
OrderBoxCoreExamples , OrderBoxDomainsExamples, OrderBoxHostingExamples, OrderBoxOtherProductsExamples – The folder contains the example files to illustrate every method in the kit.
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:
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:Inetpubwwwroot”. 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.
Open the IIS management console by navigating to “Start > Programs > Administrative Tools > Internet Information Services”
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 on the “Create” button.
If you successfully completed the above steps, you may open your browser and point it to http://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 OrderBox API.
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 “http://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. Reference: 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:
HTTP DEMO SERVICE URL: “http://api.onlyfordemo.net/anacreon/servlet/APIv3-XML”
HTTPS DEMO SERVICE URL: “https://api.onlyfordemo.net/anacreon/servlet/APIv3-XML”
The following are valid end points for the OrderBox Live Server:
HTTP LIVE SERVICE URL: “http://www.myorderbox.com/anacreon/servlet/APIv3-XML”
HTTPS LIVE SERVICE URL: “https://www.myorderbox.com/anacreon/servlet/APIv3-XML”
Example: To test the examples, you must first create an account on the Demo server. To use the Customer webservices of the OrderBox 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 = “http://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. // 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. // Since we wish to view the soap request and response … // Next we instantiate an object of the Customer class. // We then use this customer object to request the id for a specified username. // Now we display the soap request. // Then we display the soap response. // Lastly we display the 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.
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.
Tags: 10 Zip, administrator, Administrator Privileges, Api, Api Documentation, Api Guide, Api Kit, ASP.NET, Computer Option, Demo Server, Docs, Explanations, http, installation of IIS, Integration Guide, Internet Information, Internet Information Services, Javadocs, Names, Net Hosting, Option 1, Party Provider, Platforms, Properties, Reference, Setup Application, Step 1, Step 2, Third Party, Two Ways, Visual Studio.Net, www.myorderbox.com/anacreon/servlet/APIv3-XML, Xml, Zip File, Zip Net
This document describes the Validation routines which you need to build in for the various parameters which you send to the API call. Failure to validate these fields on your side may result in an undecipherable error from the Server.
General Guidelines
Any fields which are optional will require either NULL or “” to be passed to them if they are of type String, or “0″ passed to them if they are of type Numeric. The type of a parameter can be checked in the documentation supplied alongwith the kit. So for instance if you choose NOT to pass a FAX Number you will have to pass “NULL” or “” for that parameter.
Specific Parameters and their Validation
username:
role:
name:
company:
While creating a Contact, each Name and Company Name combination should be unique.
address:
langPref:
password:
city:
country:
zip:
telnocc:
telno:
alttelnocc (optional):
alttelno (optional):
faxnocc (optional):
faxtelno (optional):
Tags: Api, Arabic, Bg, C Ompany, Cou, Data Validation, E Mail Address, English Ar, Failure, Fax Number, Fi, Hebrew, Iw, Letter Iso Code, Maximum Length, Parameters, Portuguese, Reseller Name, Ru, Type String, United States Of America, Validation Routines
Ensure that you have read the following documents before Emulating any API call:
You may emulate any API call without actually installing any of the API Kits, on our server itself by following the below mentioned process:
1. Login into your Reseller Control Panel from http://manage.gossimer.biz/reseller
2. Click on the relevant Kit mentioned within Settings -> API -> Emulate API Calls
3. Fill in the relevant details in the top-frame by referring to the below mentioned link -
Read This FIRST – General API Integration Instructions
Note – If you wish to view the XML Sent and Received at the client-side, choose to print the XML Sent/Received. This will enable you to view the simulation of the XML sent by your server to our server and our server’s response thereof.
4. Select the API Method that you chose to Debug previously in the left frame and enter the relevant details in the right frame and emulate the API Call.
5. If you chose to print the XML Sent/Received previously, you will be able to view it in the right frame (after you make an API call). You may wish to save this for debugging later on.
Tags: Api, Api Examples, Data Validation, Description Data, Format Description, Integration, Left Frame, Parameters, Relevant Details, Reseller Control Panel, Server Error, Simulation, Top Frame, Xml
Changes in version 3.10
Java Docs updated
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
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
Java Docs updated
Changes related to classes and methods:
The following changes have been introduced under the DotEu class within the Domains Kit -
The following new methods have been introduced under DigitalCertificateOrder class within the Other Products Kit -
Changes in version 3.7
Java Docs updated
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.
Changes in version 3.6
Java Docs updated
Changes related to classes and methods:
getProductMetadata – Product class
getDefaultContactId – DomContactExt class
listByType – DomContact class
addTransferDomain – DomOrder class
changePrivacyProtectionStatus – DomOrder class
registerDomain – DomOrder class
| 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 |
While these methods are currently available, they are no longer supported and may be discontinued in the near future.
getHostingMetaData – WebHostingOrderData class
The invoiceOption parameter has been added to the add method of MailHostingPlanOnlyOrder, WindowsHostingPlanOnlyOrder and LinuxHostingPlanOnlyOrder classes
Changes in version 3.5
Java Docs updated
Changes related to classes and functions:
getList – Country class
getStateListForCountry – Country class
getDetails – Order class
addResellerWithStateId – Reseller class
getRegistrantAgreement
getProductCategory
getAgreement
getAllAgreements
addCoopContact – DotCoopContact class
validateDomainRegistrationParams
validateDomainTransferParams
addWithoutValidation
Changes in version 3.4
COM visible interfaces have been added for those who use ASP or VB, so that they are also able to use our DLLs.
Java Docs Updated
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.
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.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.
Tags: Api, ASP, Core Kit, Customer Signup, Demo Server, Deprecated Methods, DNS, Java, Java Docs, Kit Class, Parameters, Registerdomain, SSL, Xml
Buying Process for a single Domain Name
IMPORTANT
Modifying Domain Name Details
Reference: Domain Name Registration & Management >>
There is no single DomOrder.mod() method. Rather, you must call the relevant method to modify the appropriate property of a domain name. For example, to modify the Domain Secret, call DomOrder.modifyDomainSecret() and so on.
Modifying Domain Contact Details
Reference: Modifying the Whois / Contact Details of a Domain Name >>
There is a bit of a niggle when modifying the contacts to be used by a domain name. One can first get the contact ids for a particular domain by calling DomOrder.getDetails() with the orderid and ContactIds in the options Vector. We can then DomContact.listNames() to get a list of all contacts belonging to a particular Customer and show this in a list on the screen. We can then use DomOrder.modifyContact() to modify the contacts being used.
If the Customer chooses to modify the Registrant contact, then we should check if it is fit to be used in such a manner by calling DomContactExt.isValidRegistrantContact(). Some registries like .US and .COOP require additional information and this can be supplied to the contact with a call to DomContactExt.setContactDetails() if DomContactExt.isValidRegistrantContact() returns false.
If an attempt is made to use an incorrect contact id (one which would fail the DomContactExt.isValidRegistrantContact() test), then a InsufficientContactDataException is thrown. You can catch it and then set the details using DomContactExt.setContactDetails().
IMPORTANT
The system allows you to create an infinite number of Resellers and Sub-Resellers, each with customers under them. Orders can be placed only on behalf of the Customers and cannot be owned by Resellers or their Sub-Resellers directly. You can create as many Customers as you wish.
Reference: Videos describing the relationship between Customers and Sub-Resellers >>
Tags: Api, Buy Domain, Contact, Contacts, Coop, Correctness, Customer Id, Customer Selection, Discover, Domain Availability, Domain Name, Domain Names, Domain Registry, DomOrder.checkAvailabilityMultiple, First call, Ids, Name Servers, Nexus, Parameters, Register Domain, Register Domains, Registration Info, The
Before proceeding with the Transfer you are advised to first go check if your Domain Name can be Transferred. Click here to check if your domain name can be transferred >>
IMPORTANT
In case of a .EU Domain Name Transfer, the Expiry date is updated to 1 year from the date of Transfer and not to 1 year from the date the domain name was set to expire prior to Transfer.
For example, if a Domain Name has the Expiry date as 24 Oct, 2007 and it gets Transferred to another Registrar on 2 Sep, 2007. The new Expiry date will be 2 Sep, 2008 and not 24 Oct, 2008.
If you wish to Transfer a .EU Domain Name to Gossimer, then you need to follow the steps mentioned below:
Transfer Process for Customers
1. Login to your Control Panel from http://manage.gossimer.biz/customer.
2. In the Control Panel go to Domains -> Domain Registration -> Transfer. There, enter the Domain Name you wish to Transfer.
3. Select the Registrant Contact for this Domain Name. You may select from the available list of contacts or Add a New Contact.
It is compulsory for you to agree to the associated Product Agreement(s) by selecting the Check Box.
4. In order to avoid any downtime for the website/emails associated with your .EU domain name during the Transfer, it is necessary to mention the Name Servers already in use by your .EU domain name. You may also provide any new Name Servers that you would like to associate your .EU domain name with. Here, it is obvious that all the necessary DNS records are already created on the new Name Servers for the website/emails to be functional.
5. You need to mention any existing Child Name Servers for your .EU domain name alongwith their respective IP Addresses. This is necessary to avoid any downtime for the website/emails associated with any domain name using these Child Name Servers as their Name Servers. If you wish to Register any new Child Name Servers, you may also mention the same alongwith the respective IP Addresses. These new Child Name Servers will be Registered once the domain name is Transferred successfully.
Child Name Servers can also be Registered separately. Click here to know how >>
6. Finally, proceed with the Payment of the Invoice. Click here to read more details on Payment >>.
Now that you have placed the Transfer Order, the Registrant Contact for the Domain Name will receive an e-mail from the Registry for the Transfer Authorization process, which needs to be approved within 7 days. The Registry provides an additional grace period of 7 days for approval, in case the Transfer was not approved within the initial 7 day period. The authorization can also be provided through a fax to the Registry from the Registrant Contact. Template of the confirmation fax is provided below:
The request is processed once the Registry receives approval from the Registrant.
Transfer Process for Resellers
1. Login to your Control Panel from http://manage.gossimer.biz/reseller.
2. In the Control Panel go to Products -> Domain Registration -> Transfer. There you would have to enter the Domain Name you wish to Transfer.
IMPORTANT
Transfer request for .EU Domain Names cannot be placed from the Storefront/within the Control Panel. Hence, it is advised that you re-direct all purchase related links from within your, your company user’s and your Customer’s Control Panel to your SuperSite URL or your Custom URL (if you have integrated with our platform using our API).
Reference:
Click here to know what is SuperSite >>
Click here to read about API Integration >>
Click here to read how to integrate your Website and Shopping Cart with your Customer Control Panel >>
3. Enter the Username (Email Address) of the Customer, on whose behalf you wish to buy this Service. If the Customer is new, you can Add the Customer, by filling the form given there.
4. Select the Registrant Contact for this Domain Name. You may select from the available list of contacts or Add a New Contact.
It is compulsory for you to agree to the associated Product Agreement(s) by selecting the Check Box.
5. In order to avoid any downtime for the website/emails associated with your .EU domain name during the Transfer, it is necessary to mention the Name Servers already in use by your .EU domain name. You may also provide any new Name Servers that you would like to associate your .EU domain name with. Here, it is obvious that all the necessary DNS records are already created on the new Name Servers for the website/emails to be functional.
6. You need to mention any existing Child Name Servers for your .EU domain name alongwith their respective IP Addresses. This is necessary to avoid any downtime for the website/emails associated with any domain name using these Child Name Servers as their Name Servers. If you wish to Register any new Child Name Servers, you may also mention the same alongwith the respective IP Addresses. These new Child Name Servers will be Registered once the domain name is Transferred successfully.
Child Name Servers can also be Registered separately. Click here to know how >>
7. Finally, proceed with the Payment of the Invoice. Click here to read more details on Payment >>.
Now that you have placed the Transfer Order, the Registrant Contact for the Domain Name will receive an e-mail from the Registry for the Transfer Authorization process, which needs to be approved within 7 days. The Registry provides an additional grace period of 7 days for approval, in case the Transfer was not approved within the initial 7 day period. The authorization can also be provided through a fax to the Registry from the Registrant Contact. Template of the confirmation fax is provided below:
The request is processed once the Registry receives approval from the Registrant.
Tags: Api, Contact, Control Panel, DNS, Dns Records, Domain Registration, Domain Transfer, Domains, Downtime, Emails, Eu Domain Name, European Union, Expiry Date, Ip Addresses, Name Domain, Name Servers, Product Agreement, Registrant, Registrar, Servers, Transfer Domain
Gossimer has directly integrated the PayPal API within our system, such that by mentioning a few details in your interface and your Business PayPal Account, you can safely and securely collect money from your Sub-Resellers and Customers.
When your Customer/Sub-Reseller decides to pay you through this Payment Gateway, we send all the variables via an API Call to the PayPal Server, to get the transaction authenticated. All this while your Customer/Sub-Reseller continues to remain within their OrderBox Control Panel itself.
Before you Start
You will need to verify/perform the following before you start -
Verify that you have a Business PayPal account only. You cannot integrate a Personal PayPal account with our System.
Apply for Website Payment Pro (for US Business PayPal accounts only)
You need to apply for Website Payment Pro before you can make successful API calls to services such as DirectPayment. If you have already been approved for Pro, you also need to accept the Billing Agreement. This is sometimes overlooked by merchants who think they have already accepted this by applying for Pro, but it is indeed a separate step that must be completed after approval.
a) Login to your PayPal account [must be a Business account] from https://www.paypal.com
b) Click the Merchant Tools tab
c) From the Dropdown select
d) On the bottom of the right column, under Getting Started, click on
e) Complete the 2 page form
f) Click
At this point, your account will undergo an approval process by PayPal that generally takes 2-3 days. Once you have been approved for Website Payments Pro, login back into your PayPal account and complete these steps:
i) Click the Merchant Tools tab
ii) In the top right corner, click Accept Billing Agreement
iii) Click Agree
a) Login to your PayPal account from https://www.paypal.com
b) Click on
c) Click on
d) Mention the API Account Name as
e) Enable API Access for the following calls and click on the Save button
i) RefundTransaction
ii) GetTransactionDetails
iii) TransactionSearch
iv) DoCapture
v) DoVoid
vi) DoDirectPayment
vii) DoAuthorization
Using PayPal Direct Payment API Gateway, you would be able to accept funds from only 55 countries. The complete list of these countries is available at http://www.paypal.com/cgi-bin/webscr?cmd=_display-approved-signup-countries-outside.
Adding the PayPal Direct Payment API Gateway into your account consists of the following simple steps -
1. Login into your Reseller Control Panel from http://manage.gossimer.biz/reseller
2. Click on the Settings -> Finance & Billing -> Payment Gateway -> List / Add
3. Click on the Add Payment Gateway button and then on the Add a PayPal Direct Payment API Gateway link.
4. Enter the following details and Save your changes by clicking on the Submit button
Gateway Name – This Gateway Name would be shown to your Customers/Sub-Resellers, when they are about to make Payment. You can use something like “Credit Card Payment” or “Visa/Master Card” etc.
PayPal Account Username – The Username [e-mail address] you use to login into your PayPal Business account.
Currency – PayPal allows you to charge your Customers/Sub-Resellers in 6 different currencies. However, to use the PayPal Direct Payment API Gateway, you can only select USD Currency.
Currency Exchange Rate – If your Selling Currency differs from USD, we will have to convert the Order Value to the PayPal Currency, BEFORE we send your Customer/Sub-Reseller to PayPal. For this purpose the system needs a exchange rate between the two.
You may choose to maintain this exchange rate yourselves or let us maintain it for you. We download FOREX rates on a daily basis from a recognised source and update exchange rates for you. If however you wish to update the rates yourselves then you may do so by selecting the I would like to Maintain the currency exchange rate myself checkbox AND entering your own conversion rates.
Select the types of CREDIT CARDS that your merchant account supports - You need to select the types of Credit Card that are supported by your PayPal Account. The credit card types available are – Visa, MasterCard, American Express, Discover. You can also decide the sequence in which you want your Customers / Sub-Resellers to view these Card types on the payment page.
Payment Gateway Access Level for Customers and Sub-Resellers – Click here to know more about the Payment Gateway Transaction types and Access Levels for your Customers and Sub-Resellers >>
Deciding whether a Sub-Reseller and Customer is Credited with the Gross Amount or Net – PayPal deducts a fee per transaction. There are two types of Transactions that can pass through your PayPal integration – Invoice/Debit Note Payment, and Add Funds. Click here to know more about the Payment Gateway Transaction types and Access Levels for your Customers and Sub-Resellers >>
In case of an Add Funds Transaction, you have the option of crediting your Customers/Sub-Resellers with the NET Amount that PayPal credits you with, or choose to credit them with the gross funds and bear the charges yourselves.
If you have selected to credit a Customer/Sub-Reseller with the Net Amount in an Add Funds transaction, then you must submit either a Fixed Transaction fee (greater than 0) or a Variable Transaction fee (greater than 0).
Send me a Reminder if a transaction is pending for more than x days – In case you have not yet accepted a payment sent to you via the PayPal Payment Gateway, you can get e-mail reminders sent across to you from our system, after every x number of days, until you either Approve or Decline these payments. Click here to know how to Approve / Decline Payment Gateway transactions >>
Display Position – If you plan on adding Multiple Gateways you can select the position in which you wish to display this Gateway on your Payment Page.
1. The SuperSite contains information about the various Payment options you offer to your Customers and also presents these options at the time of purchasing Products and Services. This data is downloaded to your SuperSite from your Control Panel and cached (stored) on the SuperSite Server. Hence, you would need to refresh the cache of your SuperSite once you have completed the above process. You can accomplish this from within your Control Panel itself by clicking on Tools -> Reload SuperSite & PartnerSite Cache -> SuperSite Payment Preferences. Click here to know what is SuperSite >>
2. After you have setup the above, you must setup a PayPal Standard Checkout Gateway as well, as per the Legal guidelines mentioned by PayPal. Click here to know how >>
Tags: American Express, Api, Api Calls, Business Account, Control Panel, Gossimer, Interface, Merchant Tools, Merchants, Money, OrderBox Control Panel, Payment Gateway, Paypal, Paypal Account, Paypal Payment, Personal Account, Resellers, Tab C, Variables, Website Payments Pro, Www Paypal, www.paypal.com
Tags: Acceptable Usage Policy, Api, Ip Address, Orderbox, Servers, Simultaneous Connections
The API is exposed using SOAP, a common web services protocol. SOAP is extremely simple to use and debug since it is an XML based protocol. While SOAP is a standardized protocol, we are using certain complex data types which are not completely compatible across all platforms. However we have written our own wrappers to handle this and we offer direct integration kits in various platforms which you can directly download and use.
When our System receives a request, it tries to complete the action immediately. If the System is unable to complete the action for some reason, it will return an error response and try to complete the action again after sometime. This ensures a high level of fault tolerance.
Due to this, it is imperative that when you encounter an error response (especially for commands that have financial implications like Registering or Renewing orders), you MUST check whether the command eventually failed or succeeded. To do this, you will have to issue additional API commands (depending on the command for which you received an error response) to check the final status of the original command.
It is recommended that you implement this querying process to check the status of API commands as a scheduled task/cron/batch process. Alternately, you can also check the status of the command by logging into your Reseller Control Panel.
Currently integration kits are available in PHP, Java, Perl and .NET. Our Server exposes all relevant methods using SOAP. SOAP is a simple XML-HTTP based protocol whose client implementations are available in EVERY language. Follow the steps below to begin making calls to the API -
Step 1. Sign up for a Demo Reseller Account
You will initially test your API scripts on our demo Server. Click here to read how to sign up for a demo Reseller account >> .
You will need the following items before you proceed to the next step
Your Signup Username
Your Signup Password
Your Parent ID
The first two items would have been entered by you during the signup. For the last item simply login to your Demo Account and click on Settings -> Personal Information -> Primary Profile.
You can use these accounts to try out various aspects of the system. However, the demo accounts are reset every day. As such, any additional orders placed herein, or any modification done to these accounts, shall cease to exist after 24 hours.
Step 2. Proceed to the corresponding API kit for your platform
Click on the links below to refer to further instructions for the platform you are developing on -
Java API Kit >>
PHP API Kit >>
.NET API Kit >>
Perl API Kit >>
Step 3. 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:
Core Docs v3_10
Domains Docs v3_10
Hosting Docs v3_10
Other Products Docs v3_10
Step 4. Refer to the Parameter Validation details of different parameters passed in any API Calls
We have a detailed document on the Validation routines which you need to build in for the various parameters which you send to the API call. Failure to validate these fields on your side may result in an undecipherable error from the Server. Click here to read about Data Validation of Parameters passed in an API Method Call >>
Step 5. Refer to the Error format document and the common errors
The first time you run any example you are likely to encounter errors if you have not followed the steps perfectly. It is important to understand the format of an error. Click here to understand the format of an error that you will receive >>
Sometimes, you may receive a 302 HTTP Redirect response from our System. Your API implementation should be capable of following such a redirect.
Step 6. Run the examples
All the above kits contain examples which you can run and test the API functionality. Try these examples out to verify everything is working fine. You should first run these examples on the Demo Server. Use the demo sign up information gathered above and the Demo Server URL below to run the examples on the demo server.
Demo Server URLs for API Kits ver 3.x and above
Java and PHP API Kits
http://api.onlyfordemo.net/anacreon/servlet/APIv3
https://www.foundationapi.com/anacreon/servlet/APIv3
Perl and .NET API Kit
http://api.onlyfordemo.net/anacreon/servlet/APIv3-XML
https://api.onlyfordemo.net/anacreon/servlet/APIv3-XML
Demo Server URLs for older API Kits
Java and PHP API Kits
http://demo.myorderbox.com/anacreon/servlet/rpcrouter
https://demo.myorderbox.com/anacreon/servlet/rpcrouter
.NET and Perl API Kits
http://demo.myorderbox.com/anacreon/servlet/XMLrpcrouter
https://demo.myorderbox.com/anacreon/servlet/XMLrpcrouter
Step 7. Refer to common errors
In this documentation we have some answers covering common errors you can expect while integrating with the API. Click here to know details about common API errors >>
Step 8. Change the information to Live information when you are ready
Once you have followed the steps above and got the test programs 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 also need to change the server URL to the live server URL.
LIVE Server URLs for API Kits ver 3.x and above
Java and PHP API Kits
http://www.myorderbox.com/anacreon/servlet/APIv3
https://www.myorderbox.com/anacreon/servlet/APIv3
Perl and .NET API Kit
http://www.myorderbox.com/anacreon/servlet/APIv3-XML
https://www.myorderbox.com/anacreon/servlet/APIv3-XML
LIVE Server URLs for older API Kits
Java and PHP API Kits
http://www.myorderbox.com/anacreon/servlet/rpcrouter
https://www.myorderbox.com/anacreon/servlet/rpcrouter
.NET and Perl API Kits
http://www.myorderbox.com/anacreon/servlet/XMLrpcrouter
https://www.myorderbox.com/anacreon/servlet/XMLrpcrouter
Refer to the corresponding kit and integration guide of the platform that you choose for further instructions.
As you duplicate your code on the live application environment, remember to change your Parent ID to the one associated with your Live Reseller account. You can find this from Settings -> Personal Information -> Primary Profile in your Reseller Control Panel.
You need to display the Registrar Registrant Agreement for Domain Names Legal document within the domain name registration buy process on your website.
It is compulsory to display this document AS IS to your Customers and get them to agree to the terms mentioned therein, before buying domain names through you. You can view this agreement from within your Reseller Admin Control Panel at Help >> Legal Agreements.
Tags: Api, Api Commands, Data Types, Demo Server, Exposed, Fault Tolerance, Financial Implications, http, Integration, Java, Java Perl, Net Server, Parent, Parent Id, Perl, Php, Platforms, Protocol, Registrar, Relevant Methods, Reseller Account, Reseller Control Panel, Soap Soap, standardized protocol, Test Scripts, web services protocol, www.foundationapi.com/anacreon/servlet/APIv3, www.myorderbox.com/anacreon/servlet/APIv3, www.myorderbox.com/anacreon/servlet/APIv3-XML, www.myorderbox.com/anacreon/servlet/rpcrouter, www.myorderbox.com/anacreon/servlet/XMLrpcrouter, Xml
Follow the instructions below to begin integration with the API using PHP -
Make sure you have read the General API Integration Instructions first. If you have already integrated the PHP API Kit at your end, read the Change Log first to know what has changed since.
Reference:
General API Integration Instructions >>
Change Log >>
The PHP API Kit is not compatible with version PHP5. You need to use version PHP4 in order to integrate the API Kit at your end.
Step 1. Download the API Kit
Click the link below to download the relevant API kits (updated on 6th March, 2008).
PHP_CoreKIT_v3_10.zip
PHP_DomainsKIT_v3_10.zip
PHP_HostingKIT_v3_10.zip
PHP_OtherProductsKIT_v3_10.zip
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 March, 2008).
Core_Docs_v3_10.zip
Domains_Docs_v3_10.zip (updated on 1st April, 2008)
Hosting_Docs_v3_10.zip
OtherProducts_Docs_v3_10.zip
Since “list” is a keyword in the PHP language, the “list()” methods in the various classes (in the PHP Kit) has been renamed to “listOrder().” However, the documentation still mentions the method name as “list” since the documentation is JAVA specific.
Instructions to pass parameters to functions using the PHP Kit
Since PHP 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 PHP.
|
Java Data |
Types Assigning values in PHP |
| String | “firstname@secondname.com” |
| int | 123 |
| HashMap (Datatype for storing name-value pair) | array(“domain.com”=>”1″) |
| Array and Vector (Datatype for storing more than one value) | array(“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
public java.util.HashMap function2(java.util.HashMap domainHash, java.lang.String[] orderby, int[] resellerId)
and domainHash is accepting the domainname and the number of years as name value pair
$result = $obj->function2(array(“domain1.com”=>1,”domain2.com”=>2),array(“column1″,”column2″),array(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(array(“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
examples/ – Pre-written examples. You can directly run these examples to test API functionality
lib/ – The PHP class files, 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 PHP scripts. Make sure that both these folders are uploaded to the same parent folder.
2. You must have PHP 4 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. Reference: General API Integration Instructions >>
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 “constants.php” in the “examples” folder, by putting in the values for your “SERVICE_USERNAME”, “SERVICE_PASSWORD”, “SERVICE_PARENTID”. The remaining settings have already been made for you in this file. You may only need to change the path for the “lib” folder if you have uploaded the lib folder elsewhere
5. The URL to which the call is made is maintained in the “config.php” file inside the “lib” folder. By default all calls are made to the demo server URL using HTTP. You can make changes to this file and redirect your calls to the appropriate server
If you are using HTTPS calls you MUST have the extension for CURL installed and enabled in your PHP installation.
6. Another important parameter maintained in the “config.php” file is the variable $DEBUG. If this variable is set to “true”, then for each call you will see the entire XML Request and Response in the output. You should keep it to “true” during testing, but set it to false on the live environment.
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 http://yourserver/examples/html and choose the required function from the links given in the left frame.
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. Reference: General API Integration Instructions >>
Step 6. Writing your own code
After running each example above, if you simply refer to the corresponding .php file in the examples 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:
(i) Include the appropriate PHP Class file as below
include($LIB_DIR.”Order.class.php”);
(ii) Obtain a pointer to the required Class. This is done by using the code below
$serviceObj = new Order($LIB_DIR . “wsdl/Order.wsdl”);
(iii) 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
$AssociativeArray = $serviceObj->setCustomerLock($SERVICE_USERNAME, $SERVICE_PASSWORD, $SERVICE_ROLE, $SERVICE_LANGPREF, $SERVICE_PARENTID, $orderId);
You will notice above that EVERY method in the docs takes the same first 5 parameters as below
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 UsernameSERVICE_PASSWORD
String : Your PasswordSERVICE_ROLE
String : This will always be a string "reseller"SERVICE_LANGPREF
String : The 2 letter code of the language in which you wish to receive errors and descriptions - "en" for EnglishSERVICE_PARENTID
int : The ID of your parent which you can get from your profile section
Remember, when passing numerical data in hashtables, please ensure that the number is passed as a String.
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. The URL that you make your calls to also needs to change to the LIVE Server URL. You will make this change in the “config.php” file in the “lib” folder
Once again note, if you are using the HTTPS URL you MUST have the extension for CURL installed and enabled in your PHP installation.
Tags: Api, Api Documentation, Api Guide, Api Kit, appropriate server, Datatype, Datatypes, Demo Server, Docs, Explanations, http, Integers, Integration Guide, Java, Java Data Types, Javadocs, Parameters, Php, Php Guide, PHP installation, Php Java, Php Kit, Php Language, Php4, Platforms, Reference, Step 1, Step 2, Variables, Web Server, Xml
Changes in version 3.10
Java Docs updated
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
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
Java Docs updated
Changes related to classes and methods:
The following changes have been introduced under the DotEu class within the Domains Kit -
The following new methods have been introduced under DigitalCertificateOrder class within the Other Products Kit -
Changes in version 3.7
Java Docs updated
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.
Changes in version 3.6
Java Docs updated
Changes related to classes and methods:
| 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 |
While these methods are currently available, they are no longer supported and may be discontinued in the near future.
Changes in version 3.5
Java Docs updated
Changes related to classes and functions:
Changes in version 3.4
Java Docs Updated
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
The name of the jar file in every kit is now unique.
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.
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.
Changes in version 2.3
Move Website 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 2.2
In customer class new method (authenticateCustomer) is added to authenticate the Customer.
Changes in version 2.1
DomUsContact.class
API for DomUsContact.class is provided
The characteristics of DomUsContact.class includes the method setContactDetails() that needs to be called for any contact used as Registrant contact for .US. for providing applicationPurpose and nexusCategory facility.
list() method
list() method of DomContact.class is now available to Customer as well as Reseller.
The function signature of listContact() is also changed – One has to pass Customer Id after Parent Id besides other parameters.
getCustomerAvailableBalance() fuction
getCustomerAvailableBalance() fuction is added to the Fund.class
This function returns the available balance of a Customer.
getCustomerId() function
getCustomerId() function is added to the Customer.class
This function returns the customer id of the customer.
The prefix of all user classes changed to Customer eg. UserService to CustomerService, UserServiceTest to CustomerServiceTest
Method signature change in DomContact.class
OLD – int add(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int customerId)
NEW – int addDefaultContact(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, int customerId)
Tags: Api, Core Kit, Customer Signup, Deprecated Methods, DNS, Java, Java Docs, Kit Class, New Domains, nexusCategory facility, Parameters, Registerdomain, Reseller, SSL
Buying Process for a Hosting Plan or Custom Package
Modifying a Hosting Plan or Custom Package
Reference: Renewing/Upgrading/Downgrading/Deleting a Web Hosting package >>
Deleting a Hosting Plan or Custom Package
Reference: Renewing/Upgrading/Downgrading/Deleting a Web Hosting package >>
Simply call del() under the appropriate HostingOrder class with the appropriate orderid.
Renewing a Hosting Plan or Custom Package
Reference: Renewing/Upgrading/Downgrading/Deleting a Web Hosting package >>
Simply call renew() under the appropriate HostingOrder class with the appropriate orderid and the months to renew for.
IMPORTANT
The system allows you to create an infinite number of Resellers and Sub-Resellers, each with customers under them. Orders can be placed only on behalf of the Customers and cannot be owned by Resellers or their Sub-Resellers directly. You can create as many Customers as you wish.
Click here to read about Customers and Sub-Resellers >>
Tags: Alternate Location, Api, Budget, Custom Package, First call, Hash, Hashes, Hosting Package, Hosting Plan, Hosting Plans, Important Information, Local Store, Plan Id, Product Key, Product Keys, Serial Number, Web Hosting package
Changes in version 3.10 Java Docs updated Changes related to 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
Changes in version 3.9 Changes related to classes and methods: The following method in the Domains Kit is deprecated and its use should be discontinued - Changes in version 3.8 Java Docs updated Changes related to classes and methods: The following changes have been introduced under the DotEu class within the Domains Kit -
The following new methods have been introduced under DigitalCertificateOrder class within the Other Products Kit - Changes in version 3.7 Java Docs updated Changes related to classes and methods: Some old parameters have been removed and new parameters introduced in their place under the following methods -
* 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.
Changes in version 3.6 Java Docs updated Changes related to classes and 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
Deprecated method
Class
New method to be used
isValidRegistrantContact
DomContactExt
isValidContact
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*
** additionalMailBoxes is the number of additional mail boxes over and above the existing ones in blocks of 100 accounts.
getProductMetadata – Product class
getDefaultContactId – DomContactExt class
listByType – DomContact class
addTransferDomain – DomOrder class
changePrivacyProtectionStatus – DomOrder class
registerDomain – DomOrder class
| 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 |
While these methods are currently available, they are no longer supported and may be discontinued in the near future.
getHostingMetaData – WebHostingOrderData class
The invoiceOption parameter has been added to the add method of MailHostingPlanOnlyOrder, WindowsHostingPlanOnlyOrder and LinuxHostingPlanOnlyOrder classes
Changes in version 3.5 Java Docs updated Changes related to classes and functions:
getList – Country class
getStateListForCountry – Country class
getDetails – Order class
addResellerWithStateId – Reseller class
getRegistrantAgreement
getProductCategory
getAgreement
getAllAgreements
addCoopContact – DotCoopContact class
validateDomainRegistrationParams
validateDomainTransferParams
addWithoutValidation
Changes in version 3.4 Java Docs Updated New Classes introduced in all Kits: Core Kit TaxService
Domains Kit DotEu DotEuContact DomOrder
Hosting Kit WindowsHostingPlanOnlyOrder LinuxHostingPlanOnlyOrder MailHostingPlanOnlyOrder MailHostingSetup WindowsHostingSetup LinuxHostingSetup
Other Products Kit DigitalCertificateOrder SiteBuilderSetup EngageSetup Changes in version 3.3 3 new functions have been added in the Core Kit under the following classes: authenticateCustomerId – Customer 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.
getApplicableTaxes
getHashedTaxRules
getEUCountryList
tradeDomain
transferDomain
add
isEUCountry
mod
add
addEuDefaultContact
validateDomainRegistrationParams
validateDomainTransferParams
addTransferDomainWithoutvalidation
addWithoutValidation
getDetails
getDetailsByDomain
getOrderIdByDomain
add
mod
renew
del
getMonthlyCostAndValidate
getModPricing
getDeletionRefundAmount
getDetails
getDetailsByDomain
getOrderIdByDomain
add
mod
renew
del
getMonthlyCostAndValidate
getModPricing
getDeletionRefundAmount
getDetails
getDetailsByDomain
getOrderIdByDomain
add
mod
renew
del
getMonthlyCostAndValidate
getModPricing
getDeletionRefundAmount
list
getHostingKeyDisplayName
getHostingParamsDisplayName
getPricingKeyPricingParamMap
getHostingKeyDisplayName
getHostingParamsDisplayName
getPricingKeyPricingParamMap
getHostingKeyDisplayName
getHostingParamsDisplayName
getPricingKeyPricingParamMap
add
getCertPrice
getPricingKeyPricingParamMap
getPricingKeyPricingParamMap
login – Customer class
getOrderIdByDomainAndProductCategory – Order class
Extensive changes made. Please download the kit and read the appropriate Javadocs for details.
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.
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.
Perl API KIT added
Before proceeding with the Transfer of your .UK Domain Name, you are advised to first confirm if your Domain Name can be Transferred. Click here to read more >>
The process of Transferring a .UK Domain Name from another Registrar is slightly different compared to the process for Domain Names under other extensions. In case of a .UK Domain Name, the inbound Transfer needs to be initiated at the Current Registrar’s end.
Once you have determined whether your .UK Domain Name can be Transferred, you need to follow the process mentioned below:
You need to provide a Tag in order to initiate the Transfer. Contact our Technical Support Team at support@gossimer.com to know the Tag.
Reference:
Click here to know what is SuperSite >>
Click here to read about API Integration >>
Click here to read how to integrate your Website and Shopping Cart with your Customer Control Panel >>
Now, enter your .UK Domain Name. You also need to provide the Security Key, which was sent to the Registrant Email Address.
Here, you will be initiating the final step related to the Transfer of your .UK Domain Name to Gossimer and not a fresh Transfer.
On the next page, you need to provide the Customer Username (Email Address) under whom the Domain Name needs to be placed.
You will receive a notification via email from Gossimer, once the Domain Name has been activated under your Control Panel.
Tags: Api, Api Reference, Control, Control Panel, Current, Current Registrar, Custom Url, Domain Registrar, Domain Transfer, Email, Gossimer, Inter, Inter-Registrar, Notifications, Registrant, Registrar, Registrar Transfer, Security Key, Storefront, Technical Support Team, Transfer Request, Uk Domain Name, Uk Domain Names, Uk Email