reseller

is added when reseller has a customer specific business

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.

Note

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. Follow the steps below to begin making calls to the API:

Sign up for a Demo Reseller Account and Register your IP Address to make API calls

Signup for a Demo Reseller Account (Anchor: demo)

You will initially test your API scripts on our Demo server.

Additional Information

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

Note
  • The first two items would have been entered by you during the signup.

  • For the last item, follow the below process:

  • You can use the Demo account to try out various aspects of the system. However, the Demo accounts are reset every day. As such, any Orders placed herein, or any modification done to these
    Orders, shall cease to exist after 24 hours.

Register your IP Address to make API calls (Anchor: register)

  1. Login to your Demo Reseller Account from https://cp.onlyfordemo.net/reseller

  2. Go to Settings -> API

  3. Register the IP addresses from where you will be making the SOAP API requests.

Note
  • This interface is common for the HTTP and SOAP API.

  • If you have registered your IP Address for either the HTTP API or the SOAP API, you do not need to perform the above-mentioned steps.

Additional Information

HTTP API

Download the API Kit Suitable for your Platform

Note

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

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_16

Domains Docs v3_16

Hosting Docs v3_16

Other Products Docs v3_16

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. See details

Refer the Error format Document and 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. See details

Note

Sometimes, you may receive a 302 HTTP Redirect response from our system. Your API implementation should be capable of following such a redirect.

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

https://soapapi.com/anacreon/servlet/APIv3

https://soapapi.com/anacreon/servlet/APIv3

Perl and .NET API Kit

https://soapapi.com/anacreon/servlet/APIv3-XML

https://soapapi.com/anacreon/servlet/APIv3-XML

Demo Server URLs for older API Kits

Java and PHP API Kits

https://soapapi.com/anacreon/servlet/rpcrouter

https://soapapi.com/anacreon/servlet/rpcrouter

.NET and Perl API Kits

https://soapapi.com/anacreon/servlet/XMLrpcrouter

https://soapapi.com/anacreon/servlet/XMLrpcrouter

Refer the Common Errors

Here we have some answers covering common errors you can expect while integrating with the API. See details

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.

Update your Application with Live Details (Anchor: golive)

Replace the following information in your application when you are ready to go live:

Refer the corresponding kit and integration guide of the platform that you choose for further instructions.

Note
  • 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.

Interface Settings

You can decide the number of records to be displayed on any List page, within any interface in your Control Panel, by following these instructions:

  1. Login to your Reseller Control Panel. See details

  2. In the menu, point to Settings -> Personal Information and then click Interface Settings.

  3. Enter the number of records you wish to see on any List page, in the space provided.

  4. Click Submit.

Note

You will encounter the below error message in case you specify a value lower than 10 and greater than 500 -

Invalid No. of Records specified. Please enter a value between 10 and 500.

Legal Agreements

The OrderBox interface allows you set your own Legal Agreements for your Sub-Resellers and Customers. While provides you with sample Legal Agreements, we suggest that you maintain the same information with minor modifications.

It is compulsory for your Sub-Resellers and Customers to agree to the Terms and Conditions laid down in these agreements while purchasing Services.

You can View and Modify these Agreements by following this process:

  1. Login to your Control Panel. See details

  2. In the Menu, point to Settings and click Legal Agreements.

  3. You will be presented with both the Sub-Reseller as well as the Customer Agreements.

  4. Click any Agreement that you want to view/modify.

  5. The Text Box will display the Default Agreement. Copy the content of the Agreement, select the Use my own Agreement as pasted below option from the Select your Agreement Preference
    drop-down menu, paste the modified content and click Save Changes to update the Agreement.

Note

The SuperSite and PartnerSite allow you to display Legal Agreements to your Customers and Sub-Resellers respectively. This data is downloaded to your SuperSite and PartnerSite from your Control Panel and cached (stored) on the SuperSite and PartnerSite Server respectively. The cache of your SuperSite and PartnerSite will be reloaded automatically, once you have completed the above process. This way, the updated details will be downloaded to your SuperSite and PartnerSite from your Control Panel.

Additional Information

SuperSite

PartnerSite

Displaying Announcements in your Sub-Resellers and/or Customers Control Panels

You can post Notices within your Customer's / Sub-Reseller's Control Panels, by using the Announcements feature in your Reseller Control Panel. These announcements could be on various topics
ranging from Upcoming/Ongoing Discounts, Feature releases, Downtime notices, etc.

Upon setting an announcement, it would appear as a full page announcement (like a splash page) to your Customers / Sub-Resellers in their Control Panel, the moment they login, until the Announcement expiry date passes. The full page Announcement is displayed to your Customers / Sub-Resellers only the first time they login and then onwards appear in the Announcements box on the first page of their Control Panel. This Announcements box only displays

  • the latest 3 notices within the Customer Control Panel, and

  • the latest notice within the Sub-Reseller Control Panel

and then archives these announcements under Help -> Announcements section within the Customer / Sub-Reseller Control Panel.

 

Adding an Announcement

  1. Login to your Reseller Control Panel. See details

  2. In the Menu, point to Customers -> Announcements or Sub-Resellers -> Announcements to post separate notices for them. Alternatively, you can set the same notice for both types of users, by visiting either of the above paths and toggling the Show Announcement to option while Adding an Announcement.

  3. Click Add.

  4. In the Announcement Details form, enter the following details and save the changes by clicking the Submit button:

    • Title: This is the main heading under which the Announcement will be displayed in plain text to your Customers / Sub-Resellers.

    • Teaser: This is a short text summary of the Announcement and is displayed next to the Title.

    • Body: Here you can mention the complete content of your Announcement in HTML. You would have to define Line Breaks by specifying appropriate tags like <br> or <br />, while paragraphs need to be enclosed within <p> and </p> tags.

    • Start Date: This is the date from when you want an Announcement to start appearing in your Customer's / Sub-Reseller's Control Panels. By default the drop down shows the next day but it allows you to select either today's date or any day in the future. You can not select a date in the past. If you select a date in the future, then the  Announcement would start appearing from that date. The Start Time by default is 12.00.01 am GMT/UTC.

    • Expiry Date: This is the date from when you want to stop showing this Announcement to your Customers / Sub-Resellers. The Expiry Time by default is 11.59.59 pm GMT/UTC.

    • Show Announcement to: You can choose to display an Announcement to either your Customers / Sub-Resellers or both, by selecting the appropriate radio button.

    • Select Don't show this Announcement to my Sub-Reseller/Customer who signs up after the Announcement Start Date, if you are announcing something (like a Sale or Discount offer) to any Customers / Sub-Resellers who have signed up before the Announcement starts showing up.

Upon adding the Announcement, it would start appearing in your Customer's / Sub-Reseller's Control Panel from the Start Date at 12.00.01 am GMT/UTC.

 

Modifying an Announcement

You may modify your Announcement at anytime before the Start Date, by following the below mentioned process:

  1. Login to your Reseller Control Panel. See details

  2. In the Menu, point to Customers -> Announcements or Sub-Resellers -> Announcements depending upon whether you wish to modify your Sub-Reseller's or your Customer's Announcement.

  3. Click the Title link of Announcement that you wish to modify and hit the Modify button.

  4. Make the requisite modifications and Submit the same.

Note

If you wish to modify an announcement whose Start Date has already passed, then you have to Delete it (as mentioned below) and add the corrected announcement.

 

Deleting an Announcement

You may delete your Announcement at anytime after posting it. Follow the below mentioned process to delete your announcement:

  1. Login to your Reseller Control Panel. See details

  2. In the Menu, point to Customers -> Announcements or Sub-Resellers -> Announcements depending upon whether you wish to delete your Sub-Reseller's or your Customer's Announcement.

  3. Click the Title link of Announcement that you wish to delete and hit the Delete button.

  4. Confirm the deletion by clicking the Ok button to delete the announcement.

Sending Mails to your Sub-Resellers and/or your Customers

You can use the Send Mail tool provided within your Control Panel, to send e-mails to all/selected Customers / Sub-Resellers of yours, regarding your various product offerings, pricing changes, downtime outages, etc..

You can target your Customers / Sub-Resellers, by searching for them according to one or more of the following criteria:

  • Customer / Sub-Reseller Ids (comma-separated): If you wish to mail to only a specific set of your Customers / Sub-Resellers, then you need to specify their IDs as comma separated values. Leave this blank if you do not want to narrow your list of mail recipients.

  • Customer / Sub-Reseller Name: You can specify the Customers / Sub-Resellers Name to whom you want to mail by entering data in this box. Leave this blank if you do not want to narrow your list of mail recipients.

  • Customer / Sub-Reseller Username (Email Address): You can specify the Customers / Sub-Resellers Username to whom you want to mail by entering data in this box. Leave this blank if you do not want to narrow your list of mail recipients.

  • Customer / Sub-Reseller Company: You can specify the Customers / Sub-Resellers Company Name to whom you want to mail by entering data in this box. Leave this blank if you do not want to narrow your list of mail recipients.

  • Customer / Sub-Reseller City: You can specify the Customers / Sub-Resellers City to whom you want to mail by entering data in this box. Leave this blank if you do not want to narrow your list of mail recipients.

  • Customer / Sub-Reseller Country: You can specify the Customers / Sub-Resellers Country to whom you want to mail by selecting the name of a Country in this box. Leave this field at the Select a Country option, if you do not want to narrow your list of mail recipients.

  • Customer / Sub-Reseller Status: You can either mail your Active, Suspended or Any (except Deleted) Customers / Sub-Resellers by selecting one of the values in the drop down
    menu. Select Any (except Deleted) if you do not want to narrow your list of mail recipients. In case of Sub-Resellers, an additional status can be specified as Pending Activation.

  • Creation Date: The Creation Date indicates the date when a Customer / Sub-Reseller signed up under you. You must select the Creation Date correctly before being able to send an email to your Customers / Sub-Resellers, by selecting a pre-defined timeframe or specify your own date range. Select All (Slowest Search), to mail all of your Customers / Sub-Resellers.

  • Total Receipts Between: You can target your email to a specific set of Customers / Sub-Resellers who have deposited/done business with you to a specific figure. Leave this blank if you do not want to narrow your list of mail recipients.

  • Products: You can mail specific Sub-Resellers who have only signed up for or not signed up for any Product and Service, by toggling the appropriate options. Leave this option on Signed up for -> Select a Product, if you do not want to narrow your list of mail recipients.

  • Order By: You can sort the list of mail recipients to send mail to, by selecting one of these options.

This tool empowers you with a communication medium, to market your products and services to all your Customers / Sub-Resellers, without you having to use any external means of going about the same.

Sending an E-Mail to your Customers / Sub-Resellers

  1. Login to your Reseller Control Panel. See details

  2. To send an e-mail campaign to your Sub-Resellers, point to Sub-Resellers in the Menu and click Send Mail. Similarly, point to Customers in the Menu and click Send Mail to send an e-mail campaign to your Customers.

  3. Enter one or more details (as explained above) to send a targeted mail to a select set of clients, based on the parameters that you have chosen and click the Submit button.

  4. Create an e-mail campaign by filling in all the details mentioned below:

    • To: While emailing your Sub-Resellers, you can decide to send emails to either their Reseller Username Email Address or their Billing Contact Email Address or their Sales Contact Email Address or their Technical Support Contact Email Address or their Abuse Desk Contact Email Address, depending upon the nature of this email.

      All mails sent to Customers are delivered to their Customer Username Email Address itself.

    • From Name: Depending upon the content of the email, you may choose to send this email from different From Names (like a sales letter may be sent from your Sales Team).

    • From Address: The From Email Address needs to be relative to the From Name (like the sales letter may be sent through sales@your-comany-domain.com).

    • Send Reply to: Mention any email address where you want your Customers / Sub-Resellers to respond to, in case they want to discuss some aspect of the email that you are sending them.

    • Subject: This line signifies the title of the email that you are sending to your Customers / Sub-Resellers and should convey the gist of the email.

    • Content Type: You can choose to send emails in either plain Text or HTML format, by selecting the same in the drop down.

    • Message: The complete content of your email needs to be mentioned in this field. In case you are sending an HTML email, remember to set line breaks (<br> or <br />) or enclose paragraphs within
      <p> and </p> tags.

    • Confirm Delivery to: Any email address specified in this field is sent a confirmation email, that all your mails have been sent by the system. This ensures that you are informed about the system having mailed each one of your Customers / Sub-Resellers to whom you were mailing using the Send Mail tool.

    • Send Errors to: Mention an email address here where the system would forward you all undeliverable messages due to any network or recipient's mail server error or any recipient's mail account related errors.

  5. Click the Preview button to review your message before sending. If you are satisfied with the outlook of your message, send the email by clicking the Confirm button.

Note

At any point of time you can launch up to 4 email campaigns using the Send Mail Tool. You will be able to send another email campaign after at least one of the previous 4 campaigns have been completely sent out by the system.

For example, if you have chosen to send emails to your Sub-Resellers based in USA, that is treated as a single email campaign. Another campaign could be a Send Mail to all your Customers. Just like these, you can at a time send 4 email campaigns and the system will not allow you to send another campaign until one of these 4 campaigns have been sent by the system.

Viewing all important Announcements posted in your Control Panel

From time to time may post important Announcements within your Control Panel. This Announcement would appear to you:

  • immediately upon login into your Control Panel as a full page. After you have read the Announcement, you can click the Proceed button to continue working with your Control Panel.

  • only once as a full page Announcement. After you have seen the Announcement once, it would start appearing in the Announcement box, from where you can click either its Title or Teaser line to view the complete announcement.

  • as an Archived Announcement, after the Announcement has expired. Archived Announcements can be view by pointing to Help in the Menu and clicking Announcements.

Viewing your Login History

  1. Login to your Control Panel. See details

  2. In the Menu, point to Tools and click Login History.

  3. Mention the following parameters and click Search:

    • Username (Email Address): You may select to either view your own Login History or any of your Company Users, by selecting the appropriate value
      from this drop-down menu.

      Select All Users to view your Login history as well as your Company User's.

    • Login Date: You may specify the duration for which you need the Login History.

    • Ip Address: If you wish to view the Login History from some specific IP Address(s), you can mention it/them here.

    • Order By: You may choose to display the Login History sorted by either the Username (Email Address), Login Date or Ip Address,
      through this option.

    Note

    If you click the Search button while leaving all the fields blank, only the Login History for the last 1 week will be displayed.