msgbartop
Gossimer’s Premier Web Hosting and Domain Registration Knowledgebase.
msgbarbottom

11 Mar 10 Change Log

Changes in version 3.10

  1. Java Docs updated
     

  2. Changes related to classes and methods:

    New Classes and Methods

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

    New Parameters introduced in Existing Methods

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

    Deprecated Parameters in Methods


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

    Deprecated Methods


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

 

Changes in version 3.9

  1. Java Docs updated
     
  2. Changes related to classes and methods:

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

    Deprecated method Class New method to be used
         
    isValidRegistrantContact DomContactExt isValidContact

 

Changes in version 3.8

  1. Java Docs updated
     

  2. Changes related to classes and methods:
     

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

      • New methods
         
        • trade
        • transfer
           
      • Deprecated methods
         
        • tradeDomain
        • transferDomain

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

      • enrollForThawteCertificate
      • reissue
      • renew
      • checkDigitalCertificateStatus
      • del
      • cancelDigicertOrder
      • changeDigicertPassword
      • addAdditionalLicenses
      • getDetails
      • getDetailsByDomain
      • getOrderIdByDomain

 

Changes in version 3.7

  1. Java Docs updated
     

  2. Changes related to classes and methods:

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

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

     

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

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

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

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

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

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


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

     

  3. The following classes and their methods are removed:
     
    • LinuxHostingPlanOnlyOrder
    • WindowsHostingPlanOnlyOrder
    • MailHostingPlanOnlyOrder
    •  

  4. The SiteBuilderLite class has been renamed to SiteBuilder.

     

  5. Two new methods, mod and signUp, have been introduced under the Reseller and Customer classes.
     
  6. Code for registerDomain method in PERL Domains Kit has been modified.
     
  7. The return type of the ListByType method of DomContact class in the Domains Kit has been changed to Hashtable from Vector.

 

Changes in version 3.6

  1. Java Docs updated
     

  2. Changes related to classes and methods:
     

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

      getProductMetadata – Product class
       

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

      getDefaultContactId – DomContactExt class
      listByType – DomContact class
      addTransferDomain – DomOrder class
      changePrivacyProtectionStatus – DomOrder class
      registerDomain – DomOrder class

       

    • Changes to the DomOrder class in Domains Kit:
       
      1. Privacy Protection Handling is added in the bulkAdd and bulkAddTransferDomain methods.
         
      2. The ‘ns’ parameter has been removed from the validateDomainTransferParams method.
         
    • The following methods in the Domains Kit are deprecated and their use should be discontinued:
      Deprecated method Class New method to be used
           
      add DomContact addContact
      addDefaultContact DomContact addDefaultContacts
      list DomContact listByType
      add DomOrder registerDomain
      transferDomain DomOrder addTransferDomain
      transferDomainWithoutValidation DomOrder addTransferDomain
      addTransferDomainWithoutvalidation DomOrder addTransferDomain
      add DotEu registerDomain in DomOrder class

       

      IMPORTANT

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

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

      getHostingMetaData – WebHostingOrderData class
       

    • Changes to classes in the Hosting Kit:

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

     

Changes in version 3.5

  1. Java Docs updated
     

  2. Changes related to classes and functions:
     

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

      getList – Country class
      getStateListForCountry – Country class
      getDetails – Order class
      addResellerWithStateId – Reseller class
       

    • An extra option called Supersite is added in the getDetails function of the Reseller class in the Core Kit.
       
    • A new class LegalAgreement is added with the following methods under the Core Kit:

      getRegistrantAgreement
      getProductCategory
      getAgreement
      getAllAgreements
       

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

      addCoopContact – DotCoopContact class
       

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

      validateDomainRegistrationParams
      validateDomainTransferParams
      addWithoutValidation

     

Changes in version 3.4

  1. Java Docs Updated
     

  2. New Classes introduced in all Kits:

  • Core Kit

    TaxService
        getApplicableTaxes
        getHashedTaxRules
     

  • Domains Kit

    DotEu
        getEUCountryList
        tradeDomain
        transferDomain
        add
        isEUCountry

    DotEuContact
        mod
        add
        addEuDefaultContact

    DomOrder
        validateDomainRegistrationParams
        validateDomainTransferParams
        addTransferDomainWithoutvalidation
        addWithoutValidation
     

  • Hosting Kit

    WindowsHostingPlanOnlyOrder
        getDetails
        getDetailsByDomain
        getOrderIdByDomain
        add
        mod
        renew
        del
        getMonthlyCostAndValidate
        getModPricing
        getDeletionRefundAmount

    LinuxHostingPlanOnlyOrder
        getDetails
        getDetailsByDomain
        getOrderIdByDomain
        add
        mod
        renew
        del
        getMonthlyCostAndValidate
        getModPricing
        getDeletionRefundAmount

    MailHostingPlanOnlyOrder
        getDetails
        getDetailsByDomain
        getOrderIdByDomain
        add
        mod
        renew
        del
        getMonthlyCostAndValidate
        getModPricing
        getDeletionRefundAmount
        list

    MailHostingSetup
        getHostingKeyDisplayName
        getHostingParamsDisplayName
        getPricingKeyPricingParamMap

    WindowsHostingSetup
        getHostingKeyDisplayName
        getHostingParamsDisplayName
        getPricingKeyPricingParamMap

    LinuxHostingSetup
        getHostingKeyDisplayName
        getHostingParamsDisplayName
        getPricingKeyPricingParamMap
     

  • Other Products Kit

    DigitalCertificateOrder
        add
        getCertPrice

    SiteBuilderSetup
        getPricingKeyPricingParamMap

    EngageSetup
        getPricingKeyPricingParamMap
     

Changes in version 3.3

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

    authenticateCustomerId – Customer class
    login – Customer class
    getOrderIdByDomainAndProductCategory – Order class
     

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

Changes in version 3.2.1

  • WSDL Endpoint changed
     

Changes in version 3.2

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

Changes in version 3.1

  • Minor bugs in WSDL files fixed.


Version 3.0 Released

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


Changes in version 2.6

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

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

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


Changes in version 2.5

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

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

  • Link to new Demo Server added.


Version 2.3

  • Perl API KIT added

Tags: , , ,

10 Mar 10 How do I modify the links on the Static Bar on my SuperSite?

Just below the Main menu on your SuperSite, you will see a Static bar.

staticbar How do I modify the links on the Static Bar on my SuperSite?

Like all other content on SuperSite, the links on this Static bar too are completely customizable. Ideally, you would want to customize the Static bar links to provide additional information about your business to your customers (such as information about your company, news, other products that you offer, etc.).

In order to customize the links on the Static bar on your SuperSite, simply login to the Admin Area for the SuperSite and modify the template for it.

Follow the process outlined below to do so, once you have logged in to the SuperSite Admin area:

  1. Login to the SuperSite Admin Area. Click here to know how >>
     
  2. In the Admin area, click on Add/Modify Content and Themes link to open this section. Here, click on Browse next to the Website Content folder.
     
  3. Click on Browse link next to the language for which you wish to make the modification.
     
  4. This will lead you to a Common directory that contains all HTML templates you can customize. Click on Browse, besides it.
     
  5. Further, click on the Browse button besides the Header directory. There you need to go another level deep to the Includes directory by clicking on the adjacent Browse button..
     
  6. Here, look for the page static_bar_under_menu.html, and click on Edit adjacent to the page name.
     
  7. The text-box on the subsequent page contains the primary template for the Static bar. You can modify the links here to point to external URLs, or to point to local HTML pages that you may have created. To learn how to add your own HTML pages, click here >>
     

    IMPORTANT

    If you have modified this file before then the Original content would appear in the left hand box and your customization in the right-hand side. Gossimer may modify the standard content of this menu and you would need to compare content in both textboxes (Original Content and your Modified Content) and decide what changes you want to incorporate.

     

  8. Complete the modifications you wish to make, and click on Save Changes.
     

Tags: , , , , , , , , , , , , , ,

10 Mar 10 How can I customize the URL for my Control Panels?

Gossimer, LLC allows you to have Branded Control Panel URLs. You may either use Partially Branded or Fully Branded URLs to develop your Reseller business with us. Fully Branded URLs allow you to have complete anonymity from Gossimer, LLC.

IMPORTANT      

The Fully Branded Control Panel URLs can not be the same as that of your SuperSite or PartnerSite.
You must create different Branded URLs for these interfaces, in order to have the SuperSite, PartnerSite as well as the Control Panels functional at all times.

 

Partially Branded Control Panel URLs

Upon signing up as a Reseller of Gossimer, LLC, our system automatically generates Partially Branded URLs for Customer and Sub-Reseller Control Panels under you. Your Partially Branded URL would be of the form – http://prefix.myorderbox.com. The prefix can be modified to your liking as long as it is not being used by another Reseller in our system. Ideally, this prefix should be your Company Name or your Brand Name.

Once you have decided on your prefix, you would have to submit the same within your Reseller Control Panel, by following the below mentioned steps:

          

  1. Login to your Reseller Control Panel from http://manage.gossimer.com/reseller
  2. Click on Settings -> Control Panel -> URL
  3. Click on Set your Partially Branded URL Prefix. 
  4. Under the Partially Branded URL Settings section, enter your chosen Prefix. On clicking the Update button, the prefix would be assigned to you. In case this prefix is not available, you would have to select another prefix.
  5.  

IMPORTANT      

  • If upon changing your prefix, you wish to revert to the earlier one, you may do so by following the process outlined above. However, this modification is possible only within 30 days of making the change.     

  • Even after your Partially Branded prefix is changed, the old prefix cannot be used by anyone else except you for a period of 30 days. After 30 days, however, the prefix would become available for anyone to utilize.

 

Fully Branded Control Panel URLs

Besides Partially Branded URLs, you can point your own domain name to our servers and use those as your Fully Branded Control Panel URLs. Gossimer, LLC allows you to have as many Fully Branded URLs as you wish. However, you would have to create an Address Record for each URL you select. Also, please be aware that your selected Fully Branded URL cannot be of the form http://mybrandname.com/index.html.

Thus, if you have the Partially Branded URL in the form http://mybrandname.myorderbox.com and you want the Fully Branded URL as http://www.mybrandname.com, then you would have to create an Address Record for www.mybrandname.com pointing to 67.15.47.4.

Besides creating individual Address Records for each Fully Branded URL, you would have to submit the same within your Reseller Control Panel as well. Follow the steps mentioned below to accomplish this:

      

  1. Login to your Reseller Control Panel from http://manage.gossimer.com/reseller
  2. Click on Settings ->
    Control Panel -> URL
    .   
  3. Click on Control Panel URL
  4. Here, mention your primary Fully Branded Control Panel URL besides the Fully Branded Control Panel URL field. This URL would automatically be used by our system within emails sent to your Customers and Sub-Resellers.You may also submit Additional URLs in the text box underneath. 
  5. Click on Update to save the settings.
  6.  

     

IMPORTANT      

  • Upon submission of your Fully Branded Control Panel URL, you will notice that under the Control Panel URL section, your Fully Branded Control Panel URLs for your Customers and Sub-Resellers are automatically generated and displayed.     

  • Even though you have created your Fully Branded Control Panel URLs, your
    Partially Branded URLs would continue to function. You may always rely on these, in case your Fully Branded Control Panel URLs
    develop any issue.     

     

  • Without creating appropriate Address Records for your Fully Branded Control Panel URLs, your Branded URLs will not function, even though you may have submitted them within your Reseller Control Panel.

Tags: , , , , , , , , , , , , ,

10 Mar 10 Viewing all important Announcements posted in your Control Panel

From time to time Gossimer 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 on 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 on either its Title or Teaser line to view the complete announcement.
     
  • as an Archived Announcement from Help -> Announcements, after the Announcement has expired.

Tags: , , , ,

10 Mar 10 Email Hosting Setup Guide

As a Reseller, you need to take the following steps in order to start selling Email Hosting to your Customers and Sub-Resellers.

 

Tags: , , , , , , , , , , , ,

10 Mar 10 How do I make changes to the JavaScript menu in the SuperSite and PartnerSite?

Gossimer allows you to customize the JavaScript menus in your SuperSite or PartnerSite, such that you may modify/remove particular sub-menus, or even remove a particular menu altogether.

In order to make the changes required, follow the process outlined below.

  1. Login to your SuperSite or PartnerSite Admin Area. Click here to learn how >>
     
  2. In the Admin area, click on Add/Modify Content and Themes link to open this section.
     
  3. Click on Browse link next to the JavaScript Menu folder.
     
  4. Click on Browse link next to the language for which you wish to make the modification.
     
  5. Click on the Edit link adjacent to the menu_data.js file.
     

    IMPORTANT

    The menu_data.js file contains the various Menu text as well as their links. On the other hand, the menu_style.js file contains all the style elements of your JavaScript Menu. So if you need to simply make modifications to how the menu is displayed, then you need to only edit menu_style.js file. Click here to read how >>

     

  6. You will presented with two textboxes; one on the left-hand side of the page with the title as Original Content and the other on the right-hand side with the title as My Modified Content. You can make the required modifications in the My Modified Content text box.

    Example: The following code, extracted from Supersite, defines the main menu.


     with(milonic=new menuname(“Main Menu”)){
     position=”relative”;
     alwaysvisible=1;
     orientation=”horizontal”;
     style=menuStyle;
     menuwidth=760;
     aI(“image=getImage.php?src=menu-start-cover.gif;imagepadding=0;imageposition=left;_quot;);
     aI(“align=center;showmenu=Domain Names;text=  Domains   ;”);
     aI(“align=center;showmenu=Linux Hosting;text=Linux Hosting;”);
     aI(“align=center;showmenu=Windows Hosting;text=Windows Hosting;”);
     aI(“align=center;showmenu=Business Email;text=   Email    ;”);
     aI(“align=center;showmenu=Site Builder;text=Website Builder;”);
     aI(“align=center;showmenu=Business Solutions;text=Business Solutions;”);
     aI(“align=center;showmenu=Resellers;text=Resellers;image=getImage.php?src=menu-end-cover.gif;_quot;);
     

    You can modify the main menu here. You may even remove a particular menu by commenting the line in this code. For instance, the code defining the Business solutions menu commented in the fashion illustrated below, would conceal the menu on your Supersite.


     /* aI(“align=center;showmenu=Business Solutions;text=Business Solutions;”); */
     

     

  7. On completing the modification, click on Save Changes. The changes you have made will be reflected on your SuperSite or PartnerSite immediately.
  8.  

IMPORTANT

  1. If you are not satisfied with the modifications and wish to revert to the earlier setting, simply click on Reset to Default from the Edit page, to restore the default settings for that file.
     

  2. Once you modify a JavaScript file using the above tool, the status of such a file will change from Default to Modified. Once you have modified a file, we would not be able to automatically update the content of the same when new content is added by us; you would have to synchronize the content yourself. Click here to synchronize the JavaScript Menu modified by you with any new content added by Gossimer >>
     

  3.  

 

Tags: , , , , , , , , , , , , , , , , , , , , , , , ,

10 Mar 10 How can I Add/Edit my own HTML pages in the Supersite and PartnerSite?

In addition to the modifying the default HTML pages, you can as mentioned below:       

       

  1. Login to your SuperSite or PartnerSite Admin Area. Click here to learn how >> 
  2. Under the My Languages SuperSite/PartnerSite section, click on the Manage Site button besides the Language SuperSite/PartnerSite, where you wish to add/edit your HTML pages.
  3. Click on the Edit Content button. Then click on the Browse link besides the MyUploadedPages folder.

Adding your own HTML pages 

        

  1. Click on the Add your own HTML page button on the top right-hand corner of this page. 
  2. Here, enter a name for the file/page that you are adding, and add the HTML content of your page in the text-field provided. 
  3. Once you have entered the content, click on Save Changes button. The page will be uploaded to your site, can now be viewed from http://<your supersite url>/content.php?action=mypages&page=<page name> or http://<your partnersite url>/content.php?action=mypages&page=<page name>, as appropriate.
  4. After uploading your own HTML page, you would need to link it from some existing HTML page on your SuperSite/PartnerSite using the Advanced HTML editing mode.
  5.  

     

     

     

Editing HTML pages added by you 

        

  1. Click on the Edit link next to the HTML page you wish to modify. 
  2. Make changes to the original content of your file as desired.
  3. Click on Save Changes.
  4.  

     

     

     

IMPORTANT       

  1. An HTML page added by you will be specific to the Language SuperSite/PartnerSite under which it has been added. 
  2. If you have multiple Language SuperSites/PartnerSites and wish to display your HTML page in each Language SuperSite/PartnerSite, you need to add the page (with language specific content) under each Language SuperSite/PartnerSite.
  3. If a specific HTML page added by you (in a particular Language SuperSite/PartnerSite) is no longer required, the same can be deleted by clicking the Delete button next to that HTML page in individual Language SuperSite/PartnerSite. Even if you have added your own page in multiple Language SuperSites/PartnerSites with the same file name, deleting the page under a particular Language SuperSite/PartnerSite will not affect the page in the other Language SuperSites/PartnerSites.

 

Tags: , , , , , , , , , , , , ,

10 Mar 10 Balancing (Payment) of a Pending Invoice/Debit Note explained in Detail

In this answer we have tackled a detailed indepth explanation of how the system works internally when an Invoice or Debit note is settled against a Receipt/Credit Note. Lets first understand the functionality provided by the Control Panel.

There are many places where you can choose to settle the Invoices/Debit notes of your Customers/Sub-Resellers -

  • From the List View or Detailed View of an Invoice or Debit Note

  • From the Detailed View of an Order for all Invoices associated with that Order

  • After performing an Add Funds transaction, the system gives you a list of Pending Invoices and Debit Notes

An Invoice and Debit note are quite different transactions. An Invoice is always related to an underlying Order, and may actually have some action of the Order dependant on the Invoice. For instance an Invoice for Renewal of an Order, has the action of renewal dependant on the Invoice. A Debit Note on the other hand is not related directly to any Order. The system itself does not recognise any link between a Debit Note and a specific Order. However with respect to accounting effect, both of them reduce the balance of your Customer/Sub-Reseller when they are paid for. With respect to the process of settling them, they function exactly the same way. Let us examine this process of balancing of an Invoice or Debit Note

It is important to understand that by simply having an Invoice or Debit Note, it does not reduce the balance or available funds of your Sub-Resellers or Customers. You or they have to actually balance that Invoice or Debit Note (settle it) against some Receipt(s)/Credit Note(s) in order for it to reduce the available balance of your Customers/Sub-Resellers

Balancing of an Invoice/Debit Note

When you or your Customer/Sub-Reseller chooses to pay for an Invoice or Debit Note, you/he/she are given the option use the existing Debit Account balance of the Customer or Sub/Reseller to pay for the Transaction. There is also an option to Add Funds to the Debit Account, or pay online depending on what options you have enabled for your Customers/Sub-Resellers. In effect however an Invoice or Debit note gets paid through some Receipt or Credit Note. The Receipt/Credit Note could have already been added from before, or added during the Invoice/Debit Note Payment process.

Both an Invoice and a Debit Note consist of the following fields

Invoice/Debit Note Amount: This is the amount of the Invoice or Debit Note
Pending Amount: This is the amount of payment pending on this Invoice or Debit Note

The above amounts will be stored in dual currency, incase your Selling Currency is different from your Accounting Currency.

Lets journey through the payment process of an Invoice to understand what actually goes on during the Payment process. Upon confirming the balancing process, the System will attempt to balance this Invoice against existing Receipt(s)/Credit Note(s) or a New Receipt, depending on where the payment is attempted from.

Lets take a dummy Invoice for a Customer A with the following figures

Invoice ID: 1
Invoice Amount: USD 100 (INR 5000)
Pending Amount: USD 100 (INR 5000)
Conversion Rate: 50

Note the following points about the above Invoice

  • As you can see the above Invoice is fully unpaid (since the Pending Amount is equal to the Invoice Amount).

  • Additionally the Selling Currency in this example is USD and the Accounting Currency is INR.

  • The conversion rate between both is taken as 50. This conversion rate is the conversion rate at which the Invoice was entered or created manually or by the System.

Lets now Assume that the Customer A has the following Receipts in his account

Receipt ID: 1
Receipt Amount: USD 50 (INR 2450)
Pending Amount: USD 0 (INR 0)
Conversion Rate: 49

Receipt ID: 2
Receipt Amount: USD 75 (INR 3675)
Pending Amount: USD 50 (INR 2450)
Conversion Rate: 49

Receipt ID: 3
Receipt Amount: USD 75 (INR 3600)
Pending Amount: USD 75 (INR 3600)
Conversion Rate: 48

As we can see above, there are 3 Receipts, each with a different pending amount. The important aspects to note are as follows

  • Receipt ID 1 has no pending amount remaining. This means that this Receipt of USD 50 has been fully utilised against other previous transactions. Receipt ID 2 and 3 have some pending amount which can be utilised to balance this Invoice

  • The conversion rate of the Receipts is different from the conversion Rate of the Invoice. This is obvious considering that the Receipts would have been fed in on a different day from the Invoice.

Now this is what the system will do. It will gather all Receipts which have some pending amount left in them. The system will then use these Receipts one after another to balance the Invoice until either the Invoice or the Receipts are completely balanced. The important aspect in this payment process is the forex difference calculation. Since the Invoice and Receipt are both fed in at different Conversion rates, it is obvious that there will be a Forex gain or loss with respect to this payment. The system automatically calculates this Forex Gain/Loss and stores it against the Invoice for you to account it appropriately. Here is how this works -

In the above case the system would first inspect Receipt ID 2. This Receipt has a pending amount of USD 50. Here we bring up an important point. When the system is balancing Invoices or Debit notes, it is actually balancing the Selling Currency Amount. What this basically means is if your Invoice is for USD 100, the system will attempt to balance Receipts worth USD 100 against this Invoice. By now you would have got a clue as to how the Forex diff would come into picture. In the process of balancing USD 100 from receipts, the INR amount used up from the Receipts would not be the same as the INR amount of the Invoice, since they are both fed in at different conversion rates. This leads to the Forex Diff. Lets see how this calculation works.

In the case above the System will use USD 50 from Receipt ID 2 and USD 50 from Receipt ID 3 in order to balance the USD 100 Invoice. In this process let us compute the INR amount of each Receipt that is used up

Receipt ID: 2
USD Amount utilised: USD 50
INR Amount utilised: USD 50 x 49 (Conversion rate) => INR 2450

Receipt ID: 3
USD Amount utilised: USD 50
INR Amount utilised: USD 50 x 48 (Conversion rate) => INR 2400

Total USD Amount Utilised: USD 100
Total INR Amount Utilised: INR 4850

The above calculation shows the amounts utilised in both currencies to fulfill an Invoice of USD 100. The Invoice amount in INR as we know was INR 5000. Against that we have Receipts of INR 4850. The difference between these is the Forex Loss of (INR 150). Below we have the final status after the payment is completed

Invoice ID: 1
Invoice Amount: USD 100 (INR 5000)
Pending Amout: USD 0 (INR 0)
Forex Loss: INR 150

Receipt ID: 2
Receipt Amount: USD 75 (INR 3675)
Pending Amount: USD 0 (INR 0)
Conversion Rate: 49

Receipt ID: 3
Receipt Amount: USD 75 (INR 3600)
Pending Amount: USD 25 (INR 1200)
Conversion Rate: 48

At the end of the transaction the Invoice is fully balanced, Receipt ID 2 is fully utilised, Receipt ID 3 is partly utilised and there is a Forex Loss of INR 150.

There are a few important points to note in the above transaction

  • The transaction would work in exactly the same fashion if you had a Debit Note instead of an Invoice, or a Credit note instead of the Receipt

  • The Invoice in this case was fully balanced, while the last Receipt (Receipt ID 3) was partly utilised. The reverse condition could also take place, wherein the Receipts were not sufficient to cover the Invoice Pending Amount, and therefore the Invoice would remain partly paid, and the Receipts would be fully utilised

Tags: , , , ,

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

You can post Notices within your Sub-Resellers and Customers Control Panels, by using the Announcements feature in your Reseller Admin 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 Sub-Resellers and Customers in their Control Panel, the moment they login, until the Announcement expiry date passes. The full page Announcement is displayed to your Sub-Resellers and/or Customers 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 and then archives these announcements under Help -> Announcements in their Control Panel.

 

Adding an Announcement

1. Login to your Reseller Admin Control Panel from http://manage.gossimer.biz/reseller

2. Click on 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 options while Adding an Announcement.

3. Click on Add

4. In the Announcement Details form, enter the following details before saving the changes by clicking on the Submit button

  • Title - This is the main heading under which the Announcement will be displayed in plain text to your Sub-Resellers/Customers.
     
  • 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 Sub-Resellers and/or Customers 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 Sub-Resellers and/or Customers. 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 Sub-Resellers or Customers 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 Sub-Resellers and/or Customers who have signed up before the Announcement starts showing up.

Upon adding the Announcement, it would start appearing in your Sub-Resellers and/or Customers 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 Admin Control Panel from http://manage.gossimer.biz/reseller

2. Click on Customers -> Announcements or Sub-Resellers -> Announcements depending upon whether you wish to modify your Sub-Reseller’s or your Customer’s Announcement.

3. Click on the Announcement that you wish to modify and hit the Modify button.

4. Make the requisite modifications and Submit the same.
 

IMPORTANTIf you wish to modify an announcement whose Start Date has already passed, then you have to Delete it 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 Admin Control Panel from http://manage.gossimer.biz/reseller

2. Click on Customers -> Announcements or Sub-Resellers -> Announcements depending upon whether you wish to modify your Sub-Reseller’s or your Customer’s Announcement.

3. Click on the Announcement that you wish to delete and hit the Delete button.

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

Tags: , , , , , , , , , , , ,

09 Mar 10 What are Locked Funds?

 

 

The concept of Locked funds is really simple. Every Order that is processed deducts funds from your Account. However, most Orders typically take some time to get processed. The process of executing an Order consists of several steps. There is a chance that the steps may fail and the Order does not get processed. Therefore, we deduct funds from your account only at the last step after the Processing is complete, and the Order has been successfully executed.

However, in order to prevent the possibility of your account not having funds at that time, when the Order is processed successfully, we lock the amount of funds required for a particular Order, while it is processing. As soon as the Order Processing steps are complete the Locked funds are either deducted from your account or the lock is removed depending on whether the Execution of the particular Requested Action was successful or not.

There are also times when the process of executing a particular Action of an Order takes several days. Some Requests may take 5-10 days to get processed, like Domain Name Transfers. We would in this case lock funds required for a successful completion of the Request at the beginning of the Request, as soon as it is executed. Once the Order is executed Successfully we would deduct these funds from your account. If the Order fails we would credit the Locked funds back to your account.

For example, if there is an Order executing in your account which is likely to take 5-10 days, and your purchase price for the Order is USD 10, we would then lock USD 10 out of your Available Balance and begin processing this Order. If the Order is processed successfully we would deduct this USD 10 from your balance. If the Order fails we would simply remove the lock on the USD 10.

Basically this means that when you pay us for an Order, we do not utilize those funds immediately. We lock the funds and begin processing the Order. If the processing fails then we release the lock and the funds are again available in your Account for you to use against anything else.

You can check out the complete list of Locked funds for all your Orders which are currently in processing by clicking on My Billing -> List Locked Funds. This list shows you the Orders for which funds have been locked from your account, and the quantum of funds locked for that Order.

Tags: , , , , , ,

09 Mar 10 How do I set my Branded Name Servers?

We provide you with a FREE set of Partially Branded Name Servers for all the web services that you sell. These Name Servers are hosted on Servers provided by us. These will be used by your Customers if they choose to buy any of your other services for their domain names, through Gossimer. As such, you can customize these Name Servers only if you’ve signed up for the additional services viz., Domain Forwarding, Email Forwarding and Managed DNS.

You can alternatively choose to have your own Fully Branded Name Servers pointed to ours and use them instead. This can be accomplished by following this process:-

1. Login into your Reseller Control panel from http://manage.gossimer.biz/reseller.

2. Go to Settings -> Name servers and select one of the following options

I. Partially Branded Name Servers

You will be given 4 Partially Branded Name Servers, of the form

<prefix>.mercury.orderbox-dns.com
<prefix>.venus.orderbox-dns.com
<prefix>.earth.orderbox-dns.com
<prefix>.mars.orderbox-dns.com

This <prefix> is the same as the one used for your Partially Branded Storefront URL i.e., <prefix>.myorderbox.com. Click here to know how to modify your Partially Branded Storefront URL >>
 

II. Fully Branded Name Servers

If you want Fully Branded Name Servers, then you would have to create A records pointing to the IP addresses mentioned below.

Thus, if you wish your Fully Branded Name Servers in the form

ns1.mydomainname.com.
ns2.mydomainname.com.
ns3.mydomainname.com.
ns4.mydomainname.com.

Then, you would have to create Address (A) Records for each of your Name Servers, as shown below

  • ns1.mydomainname.com: Create 3 A Records for this Name Server, each pointing to a unique IP Address from among these – 67.15.47.189, 67.15.253.220, 67.15.253.251
     

  • ns2.mydomainname.com: Create 3 A Records for this Name Server, each pointing to a unique IP Address from among these – 74.54.56.227, 74.54.56.231, 74.54.56.236
     

  • ns3.mydomainname.com: Create 3 A Records for this Name Server, each pointing to a unique IP Address from among these – 67.15.47.188, 67.15.253.219, 67.15.253.252
     

  • ns4.mydomainname.com: Create 3 A Records for this Name Server, each pointing to a unique IP Address from among these – 66.249.5.25, 66.249.5.105, 66.249.5.122
     

In addition to this, you would also have to create Child Name Servers for your Domain Name i.e., you would have to create Child Name Servers (Register Name Servers) for mydomainname.com, using the IP Addresses mentioned above.

Create/Register all Child Name Servers with the following IP Addresses -

  • ns1.mydomainname.com: Create 3 Child Name Servers for this domain name with the same Host Name, each pointing to a unique IP Address from among these – 67.15.47.189, 67.15.253.220, 67.15.253.251
     

  • ns2.mydomainname.com: Create 3 Child Name Servers for this domain name with the same Host Name, each pointing to a unique IP Address from among these – 74.54.56.227, 74.54.56.231, 74.54.56.236
     

  • ns3.mydomainname.com: Create 3 Child Name Servers for this domain name with the same Host Name, each pointing to a unique IP Address from among these – 67.15.47.188, 67.15.253.219, 67.15.253.252
     

  • ns4.mydomainname.com: Create 3 Child Name Servers for this domain name with the same Host Name, each pointing to a unique IP Address from among these – 66.249.5.25, 66.249.5.105, 66.249.5.122
     

Reference:

Click here to know how to create Child Name Servers if you have registered mydomainname.com with Gossimer >>
Click here to know how to set your Name Servers as your Customers Default Name Servers while registering domain names >>

IMPORTANT

It is imperative that you create and use all Name Servers since these Name Servers are distributed in various Data Centres around the World and in case any one of the Name Servers is down, you and your Customers will not be impacted by this.

 

Tags: , , , , , , , , , , , , , , , , , ,

09 Mar 10 Why is my Content modification interface in my SuperSite/PartnerSite Admin always opening in a specific editing mode only?

The Content modification tool would, by default, open in the Basic Text editing mode if the file contains any text that can be edited/translated; otherwise it would open in the Advanced HTML editing mode.

If you save changes in a particular editing mode, then it becomes the default editing mode for that particular file, and the interface would automatically open in this edit mode thereon (for that particular file only).

Tags: ,

09 Mar 10 Email Preferences

 

Gossimer allows you to set mail preferences for yourself and your Customers, thus deciding which mails generated by the System should be sent to you and your Customers. As an example, if you are not using our Billing system for collection of Payments, you can switch off all the mails associated with the Billing system and so on.

You need to follow the steps mentioned below - 

1. Login to your Reseller Control Panel from http://manage.gossimer.biz/reseller.

2. Go to Settings -> Mail Preferences.

3. Here, you can click on Set Specific Mail Preferences for myself/my Customers link. This would present you with a list of mails sent by the System. You can select the mails you wish to receive and disable the remaining mails. You can set the preference as Send ALL mails below to myself/my Customers or DO NOT send any of the below mails to myself/my Customers or Send Mails to myself/my Customers based on my Custom Preferences.

 

  • By default, the Email Preferences for self/Customer drop-down menu is set to Send Mails to myself/my Customers based on my Custom Preferences. Here, you can set the preference to Yes or No for individual mails.
     
  • If you wish to receive all mails, you can select the Send ALL mails below to myself/my Customers option from the drop-down menu instead of setting the preference to Yes to each and every mail individually.
     
  • If you wish to disable all mails, you can select the DO NOT send any of the mails below to myself/my Customers option from the drop-down menu instead of setting the preference to No to each and every mail individually.

 

After making appropriate selections, you can submit the same by clicking on Submit Changes.

4. Else, you can select the check box for Do not send ANY mail to me/my Customers. This would disable all mails* from being sent to you and the Set Specific Mail Preferences for myself/my Customers option would disappear.

 

 

IMPORTANT  

  • There would be certain mails which would be compulsorily sent by the System to you and your Customers, irrespective of the Mail Preferences set by you or your Customers. a. Compulsory Mails sent to you – Mails related to Spam Complaints, Control Panel Password Retrieval/Modification/Expiry Mails and Sub-Reseller Sign-up related Mails. b. Compulsory Mails sent to your Customers – Mails related to Spam Complaints and Whois Data Reminder Mails.
     
  • Your Customers can set their own preferences from within their respective Customer Control Panel through the Settings -> Mail Preferences menu. The System would check your as well as your Customer’s preferences and send mails accordingly to your Customers as explained below -If you have set the mail preference to No for a particular mail, the option to set preference for this mail would not available to any of your Customers under their Control Panel. This mail would never be sent to any of your Customers.If you have set the mail preference to Yes and a Customer under you has also set the mail preference to Yes for that particular mail, then the mail would be delivered to this Customer.If you have set the mail preference to Yes and a Customer under you has set the mail preference to No for a particular mail, then the mail would not be delivered to this Customer. Thus, in this circumstance the preference set by the Customer will override the preference set by you.
     
  • * There are certain mails sent to you and your Customers which are not compulsory mails. However, these mails cannot be enabled/disabled from the Set Specific Mail Preferences for myself/my Customers section. But these can be enabled/disabled by selecting the Do not send ANY mail to me/my Customers check box in the Email Preferences page.

    Mails sent to you – Payment related Mails, Payment Gateways related Mails, Refund Request related Mails, Bulk Action related Mails, Product Addition/Modification/Renewal/Deletion related Mails, Domain Name Restoration Mails

    Mails sent to your Customers – Payment related Mails, Refund Request related Mails, Bulk Action related Mails, Product Addition/Modification/Renewal/Deletion related Mails, Domain Name Restoration Mails

Tags: , , , , , , , ,

09 Mar 10 What is SuperSite?

SuperSite is a complete private-labeled Website for you and your Resellers. Here, your Customers as well as your Reseller’s Customers can buy various Products and Services. The SuperSite allows you and your Resellers to start selling all our Products and Services within minutes of signing up with Gossimer.

OrderBox SuperSite is

  • Fully Customizable: You and your Resellers can modify the HTML, CSS, images or the PHP code of the SuperSite, thus, allowing you 100% customization
     
  • Multi-tier: SuperSite supports an infinite level Reseller chain. You, your Resellers, their Resellers and so on can individually customize and use the SuperSite


SuperSite Features

      

  1. Over 50 pages of customizable marketing content that your Customers can refer to.
     
  2. A Feature-packed Shopping Cart which allows Customers to purchase Products through you and your Resellers. The Shopping cart also has an intelligent product suggestion tool that automatically identifies potential services that a Customer would want to buy based on their current shopping cart contents and prompts customers to make additional purchases, increasing your revenue potential during each shopping process. The SuperSite is geared to give your Customers a continuous shopping experience. Your Customers can jump from any section of the site to any other section – selecting items, viewing details and making decisions – until they finally wish to checkout.
     
  3. Intuitive Customer/Product sign-up forms.
     
  4. Integration with the OrderBox Control panels allowing your Customers to switch between the SuperSite and the Control Panels.
     
  5. Integration with the OrderBox API for fetching your Product settings, Pre-configured plans, Pricing and other information required to allow your Customers to buy your Products and Services.
     
  6. Integration with the OrderBox to provide complete Finance and Billing automation – Online invoicing, Payment Collection, Payment Gateway integration, Advance Accounts.
  7.  

     

Tags: , , , , , , , , , , , , , , , , , , , , , , , , ,

08 Mar 10 Deleting a Customer

 

In case a Customer does not want to do further business with you, you can always delete the Customer. This would remove him from your Customers list. However, Deletion would only be possible if there are no Services under that particular Customer. Please note that this process is irreversible and a Customer once deleted cannot signup again with the same Email Address. Follow the steps mentioned below to achieve the same –

 

1. Login to your Reseller Control Panel from http://manage.gossimer.biz/reseller.

2. Go to Customers -> List or Customers -> Search and search for a particular Customer.

3. From the Customers list view that appears, select the Customer that you wish to Delete.

 

4. On the Customer Details page, click on Delete button to permanently delete the Customer.

Tags: , ,

08 Mar 10 Java API Kit and Integration Guide

 

Follow the instructions below to begin integration with the API using Java -

Make sure you have read the General API Integration Instructions first. If you have already integrated the Java 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).

JAVA_CoreKIT_v3_10.zip
JAVA_DomainsKIT_v3_10.zip
JAVA_HostingKIT_v3_10.zip
JAVA_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

Step 3. Extract the files from the API Kit archive
You should get the following directory & files structure

WEB-INF/classes/ – Precompiled examples. You can directly run the examples to test API functionality
examples/src/ – The examples for using the API
WEB-INF/lib/ – The jar files that you will need in order to compile/run the classes
WEB-INF/build.xml – The API archive also contains a build.xml file. You can use this file to build the examples using Ant.

The Ant target to build the examples is build. If you do not want to use Ant, you can just compile the files in the “src” folder. You will need to include the jar files provided in the lib folder while compiling the classes.

Step 4. Run the examples
You can run the precompiled examples provided in the “classes” folder. Note the following however:

1. Upload the “classes” and “lib” folders to your server. Make sure that both these folders are uploaded to the same parent folder.

2. 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 >>

IMPORTANT 

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.

 

3. Make the appropriate changes to the “settings.properties” file in the “WEB-INFclassescomlogicboxesproperties” folder, by putting in the values for your “ResellerUsername”, “ResellerPassword” and “ParentId”. The remaining settings have already been made for you in this file.

4. The URL to which the call is made is maintained in the “settings.properties” file inside the “WEB-INFclassescomlogicboxesproperties” 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.

IMPORTANT 

If you are using HTTPS calls you MUST have JDK 1.4 or greater installed. HTTPS calls will not work with JDK 1.3 or lower.

 

5. Set your class path to include the bin folder and EVERY jar file in the lib folder. You would use the following command for that

Windows

set CLASSPATH=%CLASSPATH%;
</fullPathTo>/classes;
</fullPathToLibFolder>/aaxerces-1_4_3.jar;
</fullPathToLibFolder>/axis.jar;
</fullPathToLibFolder>/commons-discovery.jar;
</fullPathToLibFolder>/commons-logging.jar;
</fullPathToLibFolder>/jaxrpc.jar;
</fullPathToLibFolder>/junit.jar;
</fullPathToLibFolder>/logicboxes-sfnb-v2.jar;
</fullPathToLibFolder>/saaj.jar;
</fullPathToLibFolder>/servlet.jar;
</fullPathToLibFolder>/wsdl4j.jar

Linux

set CLASSPATH=$CLASSPATH:
</fullPathTo>/classes:
</fullPathToLibFolder>/aaxerces-1_4_3.jar:
</fullPathToLibFolder>/axis.jar:
</fullPathToLibFolder>/commons-discovery.jar:
</fullPathToLibFolder>/commons-logging.jar:
</fullPathToLibFolder>/jaxrpc.jar:
</fullPathToLibFolder>/junit.jar:
</fullPathToLibFolder>/logicboxes-sfnb-v2.jar:
</fullPathToLibFolder>/saaj.jar:
</fullPathToLibFolder>/servlet.jar:
</fullPathToLibFolder>/wsdl4j.jar

6. Run the java program using the command line below

java -classpath $CLASSPATH com.logicboxes.foundation.sfnb.user.CustomerServiceLocator <params for test class>

To find out the parameters that the command above takes you can simply choose to not pass any parameter the first time you run it. The example will print out the parameters that it expects.

IMPORTANT 

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.

 

Follow the same instructions above to run all the examples as below

Domain Contact example:
java -classpath $CLASSPATH com.logicboxes.foundation.sfnb.order.DomainContactServiceLocator <params required for the class>

Domain example:
java -classpath $CLASSPATH com.logicboxes.foundation.sfnb.order.DomainServiceLocator <params required for the class>

Fund example:
java -classpath $CLASSPATH com.logicboxes.foundation.sfnb.management.FundServiceLocator <params required for the class>

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 .java file in the src 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 two steps:

(i) Obtain a pointer to the required service. This is done by using the code below

com.logicboxes.foundation.sfnb.user.Customer customerObj = new com.logicboxes.foundation.sfnb.user.CustomerServiceLocator(serviceAddress).getCustomerService();

In the above call “serviceAddress” is passed as a parameter to the constructor of “CustomerServiceLocator”. This serviceAddress refers to the URL of the server to which you are communicating. You can obtain this URL from the “settings.properties” file in the “WEB-INFclassescomlogicboxesproperties” folder.

(ii) Call the required method on this object. A complete reference of all methods is available in the Java Docs. This can be achieved by using the code below

int customerId = customerObj.addCustomer(resellerUserName, resellerPassword, “reseller”,resellerLangPref, parentId, customerUsername, customerPassword, name, company,address1, address2, address3, city, state, country, zip,telNoCc, telNo, altTelNoCc, altTelNo, faxNoCc, faxNo, langPref);

IMPORTANT  

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

java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid

 

These parameters are common no matter which method you call. These parameters mean the following

java.lang.String userName: Your Username
java.lang.String password: Your Password
java.lang.String role: This will always be a string "reseller"
java.lang.String langpref: The 2 letter code of the language in which you wish to receive errors and descriptions - "en" for English
int parentid: The ID of your parent which you can get from your profile section

Step 7. Change the information to Live information when you are ready
Once you have followed the steps above and got the test examples to work successfully, you can duplicate the same code in your live application and replace the Demo Server and Reseller account information with your live username and password. The URL that you make your calls to also needs to change to the LIVE Server URL. The list of URLs are available in the “settings.properties” file inside the “WEB-INFclassescomlogicboxesproperties” folder.

Once again note, if you are using the HTTPS URL you MUST have JDK 1.4 or greater installed. HTTPS calls will not work with JDK 1.3 or lower.

Tags: , , , , , , , , , , , , , , , , , , , ,

07 Mar 10 Procedure To Retrieve XML Sent And Received

While using one of the API kits, if you encounter any error that you need to report to Gossimer, you would need to provide the XML sent and received for the call you were making. Following is the procedure that you need to follow to retrieve the XML, for the various API kits we provide:

1. PHP kit: Set the debug value to true in the lib/config.php file

2. Perl kit: Set the $debugMode to 1 in /examples/cgi-bin/constants.cgi/font/index.html>

 

3. .NET kit: Set the static property Properties.Debug = True in statics.aspx

 

Having retrieved the XML sent & received, please contact us at  support@gossimer.com, along with the following details:

  • your Reseller Username
  • Service URL you were using
  • API kit Language

Tags: , , , ,