From 4c5f84c9d0cdc9741611f15716e777302a4f3319 Mon Sep 17 00:00:00 2001 From: Alex Lushpai Date: Sat, 27 Feb 2016 18:07:46 +0300 Subject: [PATCH] update readme files --- README.md | 52 ++++++++++++++-------------- README.ru.md | 78 ++++++++++++++++++++++++++++++++++++++++++ config/config-dist.php | 55 +++++++++++++++++------------ logs/.gitkeep | 0 4 files changed, 137 insertions(+), 48 deletions(-) create mode 100644 README.ru.md delete mode 100644 logs/.gitkeep diff --git a/README.md b/README.md index ef2da44..5fd0ffb 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,13 @@ # tiu-client -Клиент для выгрузки заказов из TIU.ru в [retailCRM](http://retailcrm.ru) через [REST API](http://retailcrm.ru/docs/Разработчики/СправочникМетодовAPIV3) +Application for export orders from [tiu.ru](http://tiu.ru) to [retailCRM](http://retailcrm.ru) -##Клиент позволяет: - * Выгружать заказы из tiu.ru в RetailCRM +Can be used with [prom.ua](http://prom.ua), [deal.by](http://deal.by), [satu.kz](http://satu.kz) -##Что такое TIU -Это торговый центр в интернете, федеральная торговая площадка с конструктором сайтов и интернет-магазинов +##Setup -##Установка +Execute in your shell -####1) Выполнить команды ```sh git clone https://github.com/retailcrm/tiu-client.git cd tiu-client @@ -18,27 +15,36 @@ curl -sS https://getcomposer.org/installer | php php composer.phar require retailcrm/api-client-php ~3.0.0 ``` -####2) Отредактировать /config/config.php аналогично примеру /config/config-dist.php +Create & fill configuration file at config/config.php (see /config/config-dist.php) -##Использование +##Usage + +Create a Cron job -####Выгрузка заказов в CRM: -Выполнить команду: ```sh - /path/to/php /path/to/tiu-client/run.php +*/10 * * * * /usr/bin/php /path/to/tiu-client/run.php ``` -##Структура данных -Тиу предлагает получение заказов по ссылке вида https://my.tiu.ru/cabinet/export_orders/xml/2372403?hash_tag=47158ffb1af38cb31f1c521dc8a1e1208 в виде XML-файла. Ссылку можно получить в личном кабинете по адресу: https://my.tiu.ru/cabinet/order/export_orders +##Data structure + +tiu.ru exports orders data as xml file available via special link like this + +``` + https://my.tiu.ru/cabinet/export_orders/xml/2372403?hash_tag=47158ffb1af38cb31f1c521dc8a1e1208 +``` + +This link [can be taken from backoffice](https://my.tiu.ru/cabinet/order/export_orders) + +####XML example ```xml Иван Петров +79111111111 - test@yandex.ru + test@example.org 22.07.15 19:24 -
Новокузнецк, ул тольятти 71 кв 37
+
Новокузнецк, ул. Тестовая 71
Наличными Доставка курьером 691.00 @@ -48,8 +54,8 @@ php composer.phar require retailcrm/api-client-php ~3.0.0 Hama H-74229 hdmi 1.3 a-c (mini) 1.00 RUB - http://images.ru.prom.st/* - http://magazine-cs2372403.tiu.ru/* + http://images.ru.prom.st/hama-h-74229.jpg + http://example-shop.tiu.ru/hama-h-74229 366.00 @@ -58,8 +64,8 @@ php composer.phar require retailcrm/api-client-php ~3.0.0 Hama H-74237 hdmi 1.3 a-c (mini) 1.00 RUB - http://images.ru.prom.st/* - http://magazine-cs2372403.tiu.ru/* + http://images.ru.prom.st/hama-h-74237.jpg + http://example-shop.tiu.ru/hama-h-74237 325.00 @@ -67,9 +73,3 @@ php composer.phar require retailcrm/api-client-php ~3.0.0 ``` - -####Поля: - * атрибут `state` поля order - статус заказа. По умолчанию есть 4 статуса 'opened' - новый, 'accepted' - принят, 'declined' - отменен, 'closed' - выполнен. Также возможно добавление своих статусов вот здесь: https://my.tiu.ru/cabinet/order_v2 - * address - если поле не было заполнено клиентом, в нем будет строка "Адрес неизвестен." - * paymentType - список всех типов оплат можно увидеть по ссылке https://my.tiu.ru/cabinet/shop_settings/payment_options - * deliveryType - список всех доставок можно увидеть по ссылке https://my.tiu.ru/cabinet/shop_settings/delivery_options diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000..2774c08 --- /dev/null +++ b/README.ru.md @@ -0,0 +1,78 @@ +# tiu-client + +Клиент для выгрузки заказов из [tiu.ru](http://tiu.ru) в [retailCRM](http://retailcrm.ru) + +Данный клиент также подойдет для работы с площадками [prom.ua](http://prom.ua), [deal.by](http://deal.by), [satu.kz](http://satu.kz) + +##Установка + +Выполните следующие команды в терминале +```sh +git clone https://github.com/retailcrm/tiu-client.git +cd tiu-client +curl -sS https://getcomposer.org/installer | php +php composer.phar require retailcrm/api-client-php ~3.0.0 +``` + +Создайте и отредактируйте конфигурационный файл config/config.php аналогично примеру /config/config-dist.php + +##Использование + +Добавьте в крон задание + +```sh +*.10 * * * * /usr/bin/php /path/to/tiu-client/run.php +``` + +##Структура данных + +tiu.ru выгружает заказы в XML-файл доступный по ссылке вида + +``` + https://my.tiu.ru/cabinet/export_orders/xml/2372403?hash_tag=47158ffb1af38cb31f1c521dc8a1e1208 +``` + +Ссылку можно получить в [личном кабинете](https://my.tiu.ru/cabinet/order/export_orders) + +```xml + + + Иван Петров + +79111111111 + test@example.org + 22.07.15 19:24 +
Новокузнецк, ул. Тестовая 71
+ Наличными + Доставка курьером + 691.00 + + + 717432 + Hama H-74229 hdmi 1.3 a-c (mini) + 1.00 + RUB + http://images.ru.prom.st/hama-h-74229.jpg + http://example-shop.tiu.ru/hama-h-74229 + 366.00 + + + + 717436 + Hama H-74237 hdmi 1.3 a-c (mini) + 1.00 + RUB + http://images.ru.prom.st/hama-h-74237.jpg + http://example-shop.tiu.ru/hama-h-74237 + 325.00 + + + + + +``` + +####Поля: + * атрибут `state` поля order - статус заказа. По умолчанию есть 4 статуса 'opened' - новый, 'accepted' - принят, 'declined' - отменен, 'closed' - выполнен. Также возможно [добавление своих статусов](https://my.tiu.ru/cabinet/order_v2) + * address - если поле не было заполнено клиентом, в нем будет строка "Адрес неизвестен." + * paymentType - список всех типов оплат можно увидеть по ссылке [https://my.tiu.ru/cabinet/shop_settings/payment_options](https://my.tiu.ru/cabinet/shop_settings/payment_options) + * deliveryType - список всех доставок можно увидеть по ссылке [https://my.tiu.ru/cabinet/shop_settings/delivery_options](https://my.tiu.ru/cabinet/shop_settings/delivery_options) diff --git a/config/config-dist.php b/config/config-dist.php index a72c4a6..0f1be6a 100644 --- a/config/config-dist.php +++ b/config/config-dist.php @@ -1,39 +1,48 @@ '', - 'retailcrm_url' => 'https://site.retailcrm.ru', - 'retailcrm_apikey' => 'qwerty123', + 'retailcrm_url' => 'https://demo.retailcrm.ru', + 'retailcrm_apikey' => 'apiKeyValue', 'retailcrm_order_chunk_size' => 50, - // загружать заказы только с определенной даты (Y-m-d H:i:s) + /** + * upload orders only from a certain date (Y-m-d H:i:s) + */ 'date_from' => '', - 'order_prefix' => 'TIU', // приписывается к номеру заказа в CRM - 'set_external_ids' => false, // задавать ли externalId заказам - 'order_method' => 'tiu', // способ оформления заказа - // соответствие доставок tiu => CRM - // https://my.tiu.ru/cabinet/shop_settings/delivery_options + 'order_prefix' => '', // optional + 'set_external_ids' => false, // set externalId field + 'order_method' => 'shopping-cart', + + /** + * delivery mapping (tiu => CRM) + * https://my.tiu.ru/cabinet/shop_settings/delivery_options + */ 'delivery' => array( - 'Транспортная компания' => 'courier', + 'Транспортная компания' => 'ems', 'Доставка курьером' => 'courier', - 'Самовывоз' => 'courier' + 'Самовывоз' => 'self-delivery' ), - // соответствие оплат tiu => CRM - // https://my.tiu.ru/cabinet/shop_settings/payment_options + /** + * payment types mapping (tiu => CRM) + * https://my.tiu.ru/cabinet/shop_settings/payment_options + */ 'payment' => array( 'Наличными' => 'cash', 'Оплата банковской картой' => 'bank-card', 'Безналичный расчет' => 'bank-transfer' ), - // статусы заказов CRM => tiu - // https://my.tiu.ru/cabinet/order_v2 - // по умолчанию заданы 4 статуса: - // 'opened' - новый, 'accepted' - принят, 'declined' - отменен, 'closed' - выполнен + /** + * order statuses (CRM => tiu) + * https://my.tiu.ru/cabinet/order_v2 + */ 'order_statuses' => array( 'new' => 'opened', 'processing' => 'accepted', @@ -41,7 +50,9 @@ $сonfig = array( 'cancel-other' => 'declined', ), - // почта для логов с ошибками - 'support_email' => '', - 'support_email_subject' => 'tiu fail' -); \ No newline at end of file + /** + * email address for notification + */ + 'support_email' => 'support@example.org', + 'support_email_subject' => 'Integration problem' +); diff --git a/logs/.gitkeep b/logs/.gitkeep deleted file mode 100644 index e69de29..0000000