Introduction

How It Works

This document is a User Manual for the partnership (reseller) program, provided by ITORIS.

The program allows IToris partners re-selling Magento extensions developed by IToris. The purchase will be available directly from the partners’ websites (built on Magento).

To start participating in the program:

1. Read and agree to the Terms and Conditions.
2. Put initial payment on your balance which you will use for purchasing IToris extensions and services. IToris takes no set up or annual fee for participating in the Partner program.
3. Connect to IToris Partnerhip API via a special Magento module available on our website for free.
4. Create new products on your website(s) and associate them with IToris’s extensions.
5. Start earning money!

There are 3 extension's prices:

• IToris's original Price
• Partner Price (IToris's original price minus current partner's discount)
• Partner's Shop Price (the price Partners set for their customers)

Partner's initial minimal discount is 30%. It may increase up to 60% based on the Partner's monthly sales. Please see more details of the discounts here

The following extensions’ licenses participate in the partner programs and are available for re-selling:

• Regular (commercial)
• Premium

Please see more information about license types here

Modules for the following Magento Editions are available for re-selling:

• Community
• Professional
• Enterprise

In addition to the modules, IToris provides services associated with them (professional installation and support). These services are eligible for participation in the partner program as well, available for re-selling and are provided by IToris on Partners customers’ websites during the selected and agreed term. Installation can be provided by partners themselves as well. This can be selected in the account’s settings and will be applied to all products. If partners select to provide installation themselves, then they will not be charged for the installation when their customers order the service.

Software Part’s Overview

IToris provides API for partnership program. This API communicates with IToris server and manages partners’ extensions, balance, statistics, purchase history and so on.

No special technical background is required to integrate this API; there is a special Magento module that will provide integration in minutes. Partners install this module (please see below) and connect it with API via the interface.

The integration will take several minutes only; please follow this Manual’s instructions for setup.

System Requirements

The extension works on Magento Community Edition from 1.4.x and higher, Magento Professional Edition 1.7.x and higher, Magento Enterprise Edition 1.7.x. and higher.

The extension works with Apache 1.3.x and higher, PHP 5, Linux or IIS.

The extension’s correct work is guaranteed with the following browsers:

• IE7+
• FireFox 4.x+
• Google Chrome 15.x+
• Safari 5.x+

The correct work with other Magento versions, other browsers and Apache/PHP versions is not guaranteed.

Installation

To install IToris Partnership module please use our special Installer. First of all, make sure Magento's Compilation is disabled (System -> Tools -> Compilation). You can recompile classes after Installer has been uploaded to your site.

In case you do not see the new menu area, clear Magento cache (System -> Cache Management) and re-check.

Find IToris Partner API module in the list of available modules and press Install icon.

Follow the wizard’s steps and complete the installation. The module will be available in System -> IToris extensions -> ITORIS Partner API

In case you do not see the module there - please update Magento cache and re-check.

Connecting API and Account

Credentials to Partner Portal

To activate the partnership please connect the installed Partnership module with IToris API and your account. To do it please open partner area and click "API Configuration".

If you have purchased products from ITORIS before- please use the credentials that you have received. If not - please contact us and we will generate new credentials for you.

Test Mode and Live Mode

There are two modes provided - test mode and live mode.

Test mode allows you testing the system without real payment/purchases. Please use it first to set the configuration as well as adjust customers’ email template.

Then configure a test product on your website (or several products) and imitate the purchase, so that to see how information is displayed in your Partner Portal as well as what your customers will receive by email.

Work in test mode will only create test data in your account. No real licenses or customer accounts will be generated. No real payments will be taken by IToris.

After all settings and testing have been completed, switch to live mode to start partnership.

API Configuration

After you login there is a new area Partner. Select it from the top menu.

Open API Configuration area. There you will have API code, ability to enter IP address(es) of your website(s) as well as ability to select API mode (test or live).

1. Copy API code, open ITORIS Partner API module and paste the code there. Save the changes. You will see a message on the top that says “API Connection Error: Server's IP doesn't match any listed in the configuration. Your server's IP is …”:

2. You can copy your IP address from this message, or if you have several IPs indicate all of them and paste them to your Partner Portal (separated by commas). Press Update my IPs button to apply the changes.

3. Update the page of the Partnership module. Success message will appear.

The connection is now established.

Connecting API and Account

Products (Modules) Configuration

To start re-selling Magento modules developed by IToris please add them on your website(s) as products. Add a new Magento product in a usual way - Catalog -> Manage Products -> Add new Product

Once you have set the configuration, there will be a special area on the products’ pages in General Tab - ITORIS Partner API Configuration

For instance, you have decided to add Sales Labels module as a new product. Populate general product’s information (name, description, and so on). Then in the new area select this module from the drop-down.

You will see a table that will display prices for different license types as well as Magento Editions. More information about the licenses IToris provides can be found here.

The following information is available for each Magento Edition (Community, Professional, Enterprise):

• Full Regular License - basic license of IToris. Partially encrypted, activates one “website” (in Magento configuration terms)
  • Original Price - default price, provided by IToris before any discounts applied
  • Partner Price - the price you receive as a partner based on your discount
• Premium License - license for customizations. Open-sourced module files, activates one Magento installation (including all its “websites”)
  • Original Price - default price, provided by IToris before any discounts applied
  • Partner Price - the price you receive as a partner based on your discount
• Lite License - available for some products only. Basic license with limitations. In case a module does not have this license, no information will be displayed in the cells.
  • Original Price - default price, provided by IToris before any discounts applied
  • Partner Price - the price you receive as a partner based on your discount

Partner price shows how much the partner pays for the module. Partners have ability to set their own prices for their customers (somewhere in between original and partner price usually).

Populate the rest of the product’s information (price, images, description, options, and so on) and save the product.

Create all other products the same way. This is up to you which modules you will sell on your website(s); you can add all or some modules only.

One more important area for the products is Custom Options.

Custom Options

When you create a module (product) there is a button Create Default Custom Options.

Pressing this button opens up Custom Options area of the product as well as creates default custom options.

Custom options for the modules provide ability to select Magento edition, license type as well as services associated with modules (professional installation and support).

Depending on personal preferences partners can leave all options or part of them only. Any option can be removed (for example, if a partner works only with Community Magento, and so on).

Please Note! In case you want to include an option to the product (module) - please make sure you use the default SKU of the option.

Partners change the prices for the options the way they want.

There is Professional Installation among the options. Please select in the module’s settings in API Configuration who provides the installation (you or IToris).

If you provide the service yourself, then IToris will not charge you when your customers select installation from the custom options. If IToris provides the service, then the payment will be taken from your balance when this service is ordered by your customer.

Customer Email Template

When your customers purchase a module - they will receive a special email confirmation. For your convenience you can change the look of this email template directly in the configurations.

Please open System -> IToris extensions -> ITORIS Partner API and change the template the way you need.

• Trigger email on order status - select which status the order should receive for the email to be sent. By default Pending Magento status is selected (as soon as an order gets pending status - email is generated and sent).
• From Name - the name your customers will see when they receive the email
• From Email - the email address your customers will see when they receive the email
• Subject - subject of the email. Standard Magento variables are used in the default template
• CC, BCC - add administrator(s) email address if you wish them to receive a copy of this email
• Email Body - email’s body has been pre-created for you. Please update it the way you need. Please note, this email contains important information your customers will need to install and use the module(s) they have purchased. The following special variables are used:

{{itoris_products_list}} - this variable will be substituted with the module’s name as well as license key. Please make sure you always include it in the customer email.

{{itoris_customer_credentials_username}} - this is the username your customer receives to login to ITORIS. This username is used to gain access to the account (to manage license keys) as well as support service.

{{itoris_customer_credentials_password}} - this is the password your customer receives to login to ITORIS. This password is used to gain access to the account (to manage license keys) as well as support service.

{{itoris_support_expiration}} - free support is provided for 1 month starting from the date of the purchase. After that support can be renewed at additional charge. This is the date till which access to support stays active.

{{itoris_order_number}} - order number in your Partner Portal. If you have changed something by mistake in the template and want to return its default look - please press Reset to Default button.

Balance

To start the partnership please put the initial amount on your IToris balance. This is not a set up fee; this amount will be used for your future purchases. To do this please enter the amount you want to add to your balance and press Top Up button in Partner Portal. By default there is $500.

Your current balance will be displayed in Partner Portal in Dashboard.

When your customers purchase module from your stores, you charge them and IToris charges you, and the payment is deducted from this balance.

Please make sure your balance stays positive, as otherwise when your customers purchase modules from your stores the purchases will not pass. You will receive email notifications when the balance is low.

The minimal top-up amount to be put on your balance is $500.

Partner Portal

To open Partner Portal please login to ITORIS and select Partnership from the top menu. There you will see all your partnership details, statistics as well as manage the purchases.

Partner Portal has 3 areas:

• Dashboard
• View Sales History
• API Configuration

Dashboard is the area where you can see your statistics’ summary, top up your balance as well as see the recent purchase history of your customers.

View Sales History - in this area you can see the detailed history of your customers’ purchases.

API Configuration - in this area you can configure and set connection between your website(s) and Partnership API. Please see more information here.

Dashboard

Dashboard provides general information of your partnership as well as allows you to put additional amount on your balance as well as displays the most recent purchases of your customers.

Statistics Summary

Here you can see the mutual settlements between you and IToris. If you put your mouse over the question marks, you will see explanations of the statistics’ values. The following information is available:

• Balance - your current balance available for purchases in US dollars. Please see more information here
• Investment - this is the total amount you have put on your balance during your partnership. Part of this amount can be spent on the modules already.
• Orig. Sales - the total cost of all products and services you have purchased from IToris (and sold to your customers). This amount shows the default price of IToris, the price you would have paid if you were a regular customer.
• Sales - the total cost of all products and services you have purchased from IToris (and sold to your customers). This amount shows the real price you pay as a partner.
• Savings - the difference between Sales and Original Sales, the amount you have sales as IToris partner.
• Refunds - the amount of refunds you have made for your customers.
• Fees - the amount of all fees taken from your balance. Currently fees are taken for refunds only.
• Discount - your current discount (percentage).

View Sales History

This area displays the detailed history of the purchases your customers have made.

There is a list of all orders with search and filter on the top for a convenient management. You can click an order to open it up and view/manage its details.

In the list of orders you will see:

• Order ID - this is an ID generated by Partnership API, please use it for communications with IToris
• Date-time - date and time the purchase has been made
• Customer - full name and email of the customer
• Product - name of the purchased module(s)
• Original Price - module(s) price set by IToris
• Partner Price - partner’s discounted price (percentage of discount is shown in brackets)
• Status - there can be 4 statuses: approved (order has been approved), declined (order has not passed successfully), partially refunded (only some products/services in the order have been refunded), refunded (full order has been refunded)

View or Manage Orders

To view/manage an order click its ID to open it up.

There you will see all order details - information about the customer, prices, discounts order number and the store where the purchase has been made.

Below there is a list of all products (modules and services) that are included in the order.

In case your customer asks for a refund, you can make it from this page. There can be full or partial refund made. IToris charges you $10 (refund fee) for each refund. Please see more details here.

API Configuration

API Configuration is the area where you connect Partner API with your website(s) via IToris Partner API module. For more information about the setting and configuration please see this chapter.

Modules’ purchases

Overview

In general, the procedure of purchasing is applied in the following way:

Your customer selects a module or several products (modules) they are interested in. You can add services associated with the modules (professional installation, additional support) as custom options or configure them another way on the product page if you wish. You set the prices you consider appropriate for both modules and the services.

Once the order has been formed - customers go through a standard Magento checkout procedure and pay for the order directly on your website(s). Your website charges them in a regular way and in accordance with your configuration and settings.

During the purchase, a request is sent to IToris Partner API. While you charge your customer for the order, money is taken from your balance at IToris. You charge your customer based on the price set on your website, IToris changes your account based on the discounted price you have.

Discount

Initial discount for partners is 30% from the regular IToris prices. You can see your current discount in Partner Portal in Dashboard.

Further discounts are calculated based on the total payment you have made to IToris during the previous 31 day.

For more information about discounts’ percentage please check this page. Check Partner Discounts column there.

Every day the discount will be re-calculated based on the total for the previous 31 day.

License Key Management

After the purchase your customers will receive license key(s) in the confirmation email. Depending on the selected license type, these license keys activate either one “website” (in Magento configuration terms) including all its stores/storeviews, even if they have different domain names - regular license, or one Magento installation, including all its “websites”, stores/storeviews - premium license.

In addition, the same license can activate an unlimited number of sub-domains of a special format for development/testing. Please see all available formats here. Localhosts can be named the same way.

In case a license should be transferred to another “website” or installation - together with the license customers will receive credentials to //www.itoris.com. There they can go to My Products, find license key(s) and reset them. After that the licenses can be used anew on another “website” or installation.

You can find all your customers’ license keys in Partner Portal. Select "View Sales History" and use search to find the order by #, customer name or email.

Open the order - there you can see the license key, order status and details.

Support

ITORIS provides technical support for the partners’ customers. Support is provided for free for 1 month starting from the date of the purchase.

Then support can be prolonged at additional cost (minimal support period to be purchased is 1 month).

Support is provided via Support Desk. Customers submit support tickets; technical specialists from IToris reply them. To get access to Support Desk your customers should login to www.itoris.com and select Support from the top menu. Credentials to login there are sent in the confirmation email together with the license key.

There are some limitations applied - any conflicts of the modules with other 3rd-party extensions are not considered to be support cases. Only full compatibility between IToris’s extensions and with ‘pure’ Magento is guaranteed.

Refunds

All refunds are handled by the Partner. If your customers ask for a partial or full refund - refund your Magento order first (i.e. return money to the customer) and then cancel the order in the Partner Portal.

Please login to Partner Portal and open "View Sales History". Find the order there and open it.

There is ability to make a full or partial refund on the order details’ page. To make a full refund please use the link Refund order in Order #.

In case a partial refund is needed - please find the product(s) to be refunded below and use Refund links near them.

When a payment is refunded, you return it to your customer and IToris returns your payment back to your balance. Please note, there is a fee applied for each refund, both full and partial. The fee is fixed and equals to $10. You can see all your refunds and fees in Partner Portal in Dashboard.