29 Jul 10 Emulating API Calls
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
21 Jul 10 Read This FIRST – General API Integration Instructions
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
Gossimer in the News
- Gossimer Puts Indian Domain Extensions Up for Sale February 21, 2010Gossimer, the fastest growing domain name registration and web hosting company has announced a sale on Indian domain extensions. During the promotion period, domains ending with .in will be offered at discounted price. [PR.com] […]
- Gossimer Unveils a New & Improved Payment System February 14, 2010The Melbourne-based (Florida) web hosting and domain name registration company Gossimer has announced the inclusion of three more payment options in its system. From today the customers and the web hosting resellers can use AlertPay, WebMoney, and Liberty Reserve to pay for the domain registration as well as web hosting services. Gossimer already offered Pay […]
- Gossimer Has Opened Its Treasure Chest for Webhost Resellers January 16, 2010Gossimer, the fast growing domain name registration and web hosting company has yet again opened its door of their reseller program. This program offers a comprehensive web hosting product portfolio for resellers and resellers of Gossimer’s resellers. [PR.com] […]
- Gossimer Invites Customers to Try Digital Certificates for Free January 2, 2010Gossimer, the fastest growing domain name registration and web hosting company is offering 21 days free trial on digital certificates. This trail will allow webmasters to understand the role Https plays in building visitors’ confidence in their website. [PR.com] […]
- Gossimer Announces Special Domain Name Registration Deals December 25, 2009Gossimer, the fastest growing domain name registration and web hosting company has announced a special deal on 12 top domain extensions and that includes some CTLDs as well. This promotion is available on the registration of new domain names, and you can register as many domains as you want. [PR.com] […]
- Gossimer Announced a Transfer-in Domain Promotion to Allow Customers to Consolidate Their Domains Into One Account November 7, 2009Save money on domain name transfer to Gossimer. Gossimer is currently running an attractive promotion on domain transfer-in that will save a lot of money for the domain portfolio builder. You can transfer as many domains as you wish under this promotion. [PR.com] […]
- Gossimer Became Reseller of the Month for October October 17, 2009October brings another piece of good news for Gossimer. The fastest growing web hosting and domain name registration company has been chosen as the Reseller of the month for October by ResellerClub. [PR.com] […]
- Gossimer Offers One Year Free Extension on Domain Transfer October 3, 2009Gossimer, the fastest growing domain name registration company, is offering one year free extension with every domain name transferred to its system. This service when coupled with other services puts Gossimer in the position of price leadership. The company offers the most economic rate for domain name registration and webhosting services. [PR.com] […]
- New Deals Make Gossimer Bigger, Better and Smarter October 2, 2009October is going to be hot with offers, extended support, and enhanced serviceability, as Gossimer has acquired HiTek Networks, and launched new and improved Support desk. The web hosting world is abuzz by the two important developments in Gossimer. [PR.com] […]
- Gossimer Offers Unlimited E-mails for $1 September 28, 2009Gossimer, the fastest growing domain name and webhosting company, has announced a no-upgrade “The Ultimate Email Plan” that will give the buyer an access to unlimited email accounts for just $1/month. [PR.com] […]
Gossimer Promotions and Announcements
- TechSupport Notifications February 28, 2010Technical support information and notifications […]
- PHP4 Discontinuation - 18th September September 7, 2009As announced earlier, PHP4 will not be supported on our Linux Hosting Servers from the 18th of September, 2009. Please pass on this information to your Customers and Resellers to ensure that they can update their websites to work with PHP5. […]
- .CN Launch - Coming Soon August 16, 2009We are glad to announce the launch of .CN - the most popular and fastest growing ccTLD worldwide. The .CN domain extension has seen an exemplary growth since its launch throughout the world. Earlier this year, .CN crossed over 13 million registrations to become the second most registered domain extension after .COM. Moreover, with China now representing the […]
- Live Chat Product Discontinuation - Moved to 18th August August 16, 2009Based on feedback that we received from several Resellers, we have decided to postpone the Live Chat discontinuation to the August of 18th, 2009 at 12:30 UTC. From the 18th of August, it will not be possible to purchase new Live Chat packages but exisiting packages will continue to function normally. […]