Knowledgebase
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. IMPORTANT
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. Such checks are also recommended in cases when a query times out, due to network outages or any other reason. It is advised 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 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. IMPORTANT
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.
Click on the links below to refer to further instructions for the platform you are developing on - Java 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: 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 >> IMPORTANT
Sometimes, you may receive a 302 HTTP Redirect response from our System. Your API implementation should be capable of following such a redirect.
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 Perl and .NET API Kit http://api.onlyfordemo.net/anacreon/servlet/APIv3-XML
Java and PHP API Kits http://api.onlyfordemo.net/anacreon/servlet/rpcrouter .NET and Perl API Kits http://api.onlyfordemo.net/anacreon/servlet/XMLrpcrouter
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.foundationapi.com/anacreon/servlet/APIv3 Perl and .NET API Kit http://www.foundationapi.com/anacreon/servlet/APIv3-XML LIVE Server URLs for older API Kits Java and PHP API Kits http://www.foundationapi.com/anacreon/servlet/rpcrouter .NET and Perl API Kits http://www.foundationapi.com/anacreon/servlet/XMLrpcrouter Refer to the corresponding kit and integration guide of the platform that you choose for further instructions. IMPORTANT
|
Powered by WHMCompleteSolution
Quick Navigation
Search
