                            Краткое описание продукта
                             =========================

    Назначение

       Данное программное обеспечение предназначено для создания
       интернет-сервиса по организации  автоматического обмена WMZ<=>WMR,
       WMZ<=>WME, WMR<=>WME на веб-сайтах. Такой обмен позволяет владельцам
       сайтов получать прибыль в виде комиссионных.

    Возможности

       1. Автоматический обмен WМ в валютных парах WMZ<=>WMR, WMZ<=>WME,
          WMR<=>WME.
       2. Размещение на любой странице Вашего сайта.
       3. Возможность отображения информации о текущем курсе валют и комиссии
          обменного пункта на каждый из вариантов обмена.
       4. Возможность отображения инструкции пользователя.
       5. Возможность отображения блоков с контактной информацией службы
          поддержки и полезными ссылками.

    Администраторский интерфейс

       1. Ручная/автоматическая установка курсов валют.
       2. Установка комиссии обмена для каждой валютной пары.
       3. Установка размера валютного резерва (суммы, не подлежащей обмену).
       4. Настройка внешнего вида обменного автомата (скинов).

    Технические требования

       Требования системы WebMoney Transfer:

       1. Владелец обменного пункта должен быть зарегистрированным участником
          системы WM Transfer и иметь персональный аттестат.

       2. Для корректной работы обменного пункта необходимо после установки
          данного программного обеспечения отправить в службу технической
          поддержки системы WebMoney Transfer запрос примерно следующего
          содержания:

       "Подключите, пожалуйста, все https-интерфейсы для данного WM id. Цель -
       запуск автоматического обменного пункта.
       Адрес обменного пункта: (полный URL страницы)"

       Вам должно придти уведомление о подключении https-интерфейсов.

       ВНИМАНИЕ!!! Без подключения https-интерфейсов обменный пункт работать не
       будет.

       Требования к серверу:

       1. Хостинг на UNIX с PHP и установленным к нему модулем сURL.

       Модуль PHP cURL можно скачать с сайта производителя -
       http://curl.haxx.se. Также информация о нем (на английском
       языке) доступна на сайте PHP:
       http://www.php.net/manual/en/ref.curl.php.

       2. Возможность открыть порт 443 для соединения с центром сертификации WM.
       3. Возможность доступа к хостингу по telnet или ssh для компиляции
       модуля WMSigner.

    Комплектация

       В стоимость поставки входят:

       1. PHP- скрипты:

       skins/default/check_skin.php - шаблон окна проведения и контроля операций
                                      по обмену средств.
       skins/default/init.php       - файл конфигурации скина "по-умолчанию".
                                      Содержит определения параметров скина
    				  (стили, цвета и т.п.).
       skins/default/obmen_skin.php - шаблон главной формы обменного пункта.
       skins/default/trans_skin.php - шаблон окна выставления счета.
       check_inv.php                - модуль проведения и контроля операций по
                                      обмену средств.
       obmen.php                    - основной модуль обменного пункта.
       trans.php                    - модуль выставления счета.
       wm.inc                       - модуль для работы с https-интерфейсом системы WebMoney Transfer.
       config.inc                  - конфигурационный файл обменного пункта.

       2. Описание продукта (readme.txt).

       Для корректной установки программного обеспечения необходимо следовать
       Инструкции по установке и настройке (install.txt).

       Для удаления программного обеспечения необходимо просто удалить все
       файлы.

       В стоимость поставки не включена какая-либо техническая поддержка, а
       также установка данного ПО. Установка "под ключ" производится по
       договорённости.

       Безопасность

    Хостинга

       Необходимо выбрать надежного провайдера хостинга, а в идеале - иметь
       свой сервер. Помните, что Ваши файлы с ключами остаются доступными,
       по крайней мере, администратору компьютера, на котором размещен сайт
       (провайдеру хостинга).

    Размещения файла ключей на сервере

       Рекомендуется выбрать максимальный размер ключа (чтобы в случае
       несанкционированного доступа его было труднее скачать).

       Хранить ключ необходимо в папке, закрытой паролем, либо в папке,
       недоступной через Web (например, cgi-bin). Для ограничения доступа к
       файлам и папкам создайте файл .htaccess в папке, в которой находятся
       файлы обменного пункта, а также в папке, в которой находится файл
       ключей. В качестве примера используйте файл .htaccess в дистрибутиве.

    Средства безопасности системы WebMoney Transfer

       Подробнее о безопасном использовании системы WebMoney Transfer
       читайте на официальном сайте http://www.webmoney.ru.

        Содержание:

        1. Вкратце (быстрая установка)
        2. Копирование файлов
        3. Установка WMSigner
        4. Настройка обменного пункта

    			Инструкция по установке и настройке
    			===================================

    Вкратце

    Здесь приведена последовательность действий по установке продукта.
    Подробно каждое из действий описано в последующих разделах Инструкции.

     1. Создайте папку на сайте и скопируйте туда файлы продукта. Создайте
        пустые файлы "log" и "log_err". Скопируйте на сервер файл ключей.
     2. Установите скрипт WMSigner. Создайте файл WMSigner.ini и впишите туда
        свои данные.
     3. Отредактируйте файл config.inc. При необходимости создайте свой или
        отредактируйте существующий скин.
     4. Создайте на Вашем сайте страницу, на которой будет размещаться обменный
        пункт и подключите к ней (командой SSI или PHP include) основной
        модуль обменного пункта obmen.php.

    Перед установкой продукта обязательно убедитесь, что Ваш сервер
    соответствует предъявляемым требованиям (описанным в файле readme.txt).

    2. Копирование файлов
    ---------------------

      1. В корневой директории сайта создайте папку, в которой будет располагаться
         Ваш обменный пункт. В эту папку скопируйте файлы обменного пункта из
         комплекта поставки.

      2. В данной директории создайте два пустых файла:
         log     - в этот файл будет записываться информация обо всех совершаемых операциях.
         log_err - в этот файл будут записываться сообщения об ошибках.

      3. Также необходимо скопировать на сервер файл ключей Вашего WM магазина.
         Файл ключей не обязательно должен находиться в директории обменного пункта.
         Желательно скопировать его в наиболее защищенную директорию сервера.

         ВНИМАНИЕ!!! ОБЯЗАТЕЛЬНО ПОЗАБОТЬТЕСЬ О БЕЗОПАСНОСТИ ФАЙЛА КЛЮЧЕЙ, поскольку
         любой человек, получивший доступ к нему, может распоряжаться Вашими
         деньгами.

    3. Установка WMSigner
    ---------------------

    WMSigner - это скрипт, распространяемый системой WebMoney Transfer, который
    вырабатывает электронную цифровую подпись для работы с системой через
    https-интерфейс.

    Его необходимо установить в директорию обменного пункта (в которую Вы
    скопировали файлы).

    Дистрибутив и подробная инструкция по настройке WMSigner находятся на сайте
    системы WebMoney Transfer по адресу: http://webmoney.ru/pfdevelhttp1s1.shtml

    Если Вы правильно выполнили все инструкции по установке WMSigner, то в
    директории у Вас добавятся два файла: WMSigner и WMSigner.ini.

    WMSigner.ini должен содержать три строки с Вашими данными:
    строка 1: Ваш WM ID
    строка 2: Ваш пароль
    строка 3: путь до файла ключей

    4. Настройка обменного пункта
    ------------------------------

    После копирования файлов и установки WMSigner необходимо отредактировать
    конфигурационный файл "config.inc".

    Примеры редактирования можно посмотреть в комментариях в самом
    конфигурационном файле.

    1. Общие настройки

       $name   - название обменного пункта, выводится в основной форме.
       $namead - название обменного пункта в родительном падеже. Используется
                 при выписке счета.
       $urlad  - полный URL размещения скриптов обменного пункта.

    2. Набор совершаемых операций

       В настоящий момент обменный пункт поддерживает шесть операций обмена:

       - покупка WMR за WMZ   - покупка WMR за WME
       - покупка WMZ за WMR   - покупка WMZ за WME
       - покупка WME за WMR
       - покупка WME за WMZ

       Операции в обменном пункте сгруппированы попарно, в зависимости от того,
       какая валюта покупается. Получается три группы:

       - покупка WMR
       - покупка WMZ
       - покупка WME

       В обменном пункте можно отключить любую из групп операций. Для этого в
       конфигурационном файле служат три параметра:

       - $eToR - 1-подключить/0-отключить операции по покупке WMR
       - $eToZ - 1-подключить/0-отключить операции по покупке WMZ
       - $eToE - 1-подключить/0-отключить операции по покупке WME

    3. Дополнительные информационные блоки

       У обменного пункта есть четыре дополнительных информационных блока, для
       отображения или скрытия которых предусмотрены соответствующие переменные:

       $eKursInfo    - 1-отобразить/0-скрыть блок информации о курсах и
                       комиссии.
       $eHelp        - 1-отобразить/0-скрыть блок с инструкцией пользователя.
       $eSupportInfo - 1-отобразить/0-скрыть блок контактной информации службы
                       поддержки.
                       Для данного блока задаются еще два параметра:
                       $eSupportEMAIL - E-mail адрес службы поддержки
                       $eSupportICQ - ICQ оператора службы поддержки
       $eLinks       - 1-отобразить/0-скрыть блок с полезными ссылками. В этом
                       блоке выводится список ссылок на различные сайты (или на
                       другие разделы данного сайта), которые Вы сочтете нужными
    		   для пользователя.

       Список ссылок задается в переменной $eLinksArray.
       $eLinksArray - это двумерный массив с двумя ключами:

                       "name" - название ссылки, выводимое в блоке,
                       "link" - URL, на который ведет ссылка.

    4. Скины и шаблоны обменного пункта

       Интерфейс обменного пункта состоит из трех модулей. Создайте на Вашем
       сайте страницу, на которой будет размещаться обменный пункт и подключите
       к ней (командой SSI или PHP include) основной модуль обменного пункта
       obmen.php. Два других модуля отображаются в popup-окнах.

       Скин - это набор шаблонов и настроек отображения этих модулей.
       В настоящеевремя есть только один скин "default", файлы которого
       находятся в папке skins/default/. Дополнительные скины будут разработаны
       в последующих версиях обменного пункта.

       Если Вас не устраивает скин по-умолчанию, то Вы можете его изменить или
       создать собственный скин на его основе. Для этого папку default
       необходимо скопировать в папку skins/ и переименовать, а затем указать
       путь до новой директории скина в переменной $skinPath.

       В папке скина находятся 4 файла:

       - init.php       - файл содержит определения констант, задающих цвета и
                          стили отображения элементов обменного пункта. Эти
    		          константы далее используются в шаблонах.
       - obmen_skin.php - шаблон основной формы обменного пункта.
       - trans_skin.php - шаблон окна выписки счета.
       - check_skin.php - шаблон окна проведения операций обмена.

       Если Вы хотите просто изменить форматирование и цвета в шаблонах,
       достаточно изменить настройки в файле init.php. Если Вас не устраивает
       компоновка элементов обменного пункта (структура HTML), то Вам нужно
       отредактировать остальные файлы.

    5. Финансовые настройки

       К ним относятся курсы валют, размеры комиссии на каждую операцию и
       остаток средств в кошельках обменного пункта, которые недоступны для
       совершения операций (неприкосновенный запас).

       Курсы валюты можно задавать двумя способами: автоматически брать с
       сайта НГС или вводить вручную. По ряду причин (различие часовых поясов,
       возможные аварии на каналах провайдеров) мы настоятельно рекомендуем
       второй способ.

       Способ получения курсов валют определяется переменной $where. курс
       берется из переменных $USD_RUR (курс доллара к рублю) и $EUR_RUR (курс
       евро к рублю).

       Также на основании основных курсов вычисляются кросс-курсы доллара и
       евро, которые используются в расчетах.

       Итоговые значения курсов находятся в следующих переменных:

       $kursZR - курс доллара к рублю,
       $kursZE - курс доллара к евро,
       $kursEZ - курс евро к доллару,
       $kursER - курс евро к рублю.

       Если Вы хотите брать значения курсов с другого сайта (не НГС), то Вам
       нужно или отредактировать имеющийся скрипт получения курсов с сайта НГС,
       или написать свой скрипт, который задавал бы значения приведенным выше
       переменным.

       Для работы обменного пункта Вы также должны задать размер комиссии на
       каждую из шести возможных операций. Размер комиссии задается в процентах
       (число от 0 до 100) в следующих переменных:

       $comissZR - комиссия на покупку WMR за WMZ,
       $comissER - комиссия на покупку WMR за WME,
       $comissRZ - комиссия на покупку WMZ за WMR,
       $comissEZ - комиссия на покупку WMZ за WME,
       $comissRE - комиссия на покупку WME за WMR,
       $comissZE - комиссия на покупку WME за WMZ.

       Непоказываемый остаток (неприкосновенный запас) задается в процентном
       отношении от суммы кошельков и действует на все кошельки обменного
       пункта. Размер остатка определяется в переменной $ostatok.

       Необходимость остатка обусловлена механизмом работы системы WebMoney.
       Система WebMoney с каждого перевода берет комиссию, равную 0.8%.
       Таким образом, остаток на счете должен быть также не менее 0.8%, чтобы
       была возможность осуществить платеж на максимальную заявленную в обменном
       пункте сумму.

       По умолчанию размер остатка равен 1%.

    6. Настройки WM

       К ним относятся системные настройки, которые мы не рекомендуем Вам
       изменять:

       $wmconst__shop_wmpurse - кошелек магазина, используемого для расчетов
                                по умолчанию,
       $wmconst__invc_protect - срок протекции выписываемых счетов,
       $wmconst__invc_active  - срок действия выписываемых счетов,
       $wmconst__trans_prtime - срок протекции сделки для переводов с
       протекцией.

       А также настройки Вашего WM-магазина, которые Вам обязательно нужно
       ввести перед началом работы:

       $wmconst__shop_wmid - WM-идентификатор магазина,
       $purseZ             - номер Z-кошелька магазина,
       $purseR             - номер R-кошелька магазина,
       $purseE             - номер E-кошелька магазина.