RetailCRM-Mirror/tiu-client
1
0
Fork 0
mirror of synced 2024-11-21 20:46:04 +03:00
Code Issues Projects Releases Wiki Activity

update readme files

Browse Source
This commit is contained in:
Alex Lushpai 2016-02-27 18:07:46 +03:00
parent 12c078ad82
commit 4c5f84c9d0
4 changed files with 137 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -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
<orders date="2015-08-31 17:32">
<order id="2803303" state="new">
<name>Иван Петров</name>
<phone>+79111111111</phone>
<email>test@yandex.ru</email>
<email>test@example.org</email>
<date>22.07.15 19:24</date>
<address>Новокузнецк, ул тольятти 71 кв 37</address>
<address>Новокузнецк, ул. Тестовая 71</address>
<paymentType>Наличными</paymentType>
<deliveryType>Доставка курьером</deliveryType>
<priceRUB>691.00</priceRUB>
@ -48,8 +54,8 @@ php composer.phar require retailcrm/api-client-php ~3.0.0
<name>Hama H-74229 hdmi 1.3 a-c (mini)</name>
<quantity>1.00</quantity>
<currency>RUB</currency>
<image>http://images.ru.prom.st/*</image>
<url>http://magazine-cs2372403.tiu.ru/*</url>
<image>http://images.ru.prom.st/hama-h-74229.jpg</image>
<url>http://example-shop.tiu.ru/hama-h-74229</url>
<price>366.00</price>
<sku/>
</item>
@ -58,8 +64,8 @@ php composer.phar require retailcrm/api-client-php ~3.0.0
<name>Hama H-74237 hdmi 1.3 a-c (mini)</name>
<quantity>1.00</quantity>
<currency>RUB</currency>
<image>http://images.ru.prom.st/*</image>
<url>http://magazine-cs2372403.tiu.ru/*</url>
<image>http://images.ru.prom.st/hama-h-74237.jpg</image>
<url>http://example-shop.tiu.ru/hama-h-74237</url>
<price>325.00</price>
<sku/>
</item>
@ -67,9 +73,3 @@ php composer.phar require retailcrm/api-client-php ~3.0.0
</order>
</orders>
```
####Поля:
* атрибут `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

78
README.ru.md Normal file
View File

@ -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
<orders date="2015-08-31 17:32">
<order id="2803303" state="new">
<name>Иван Петров</name>
<phone>+79111111111</phone>
<email>test@example.org</email>
<date>22.07.15 19:24</date>
<address>Новокузнецк, ул. Тестовая 71</address>
<paymentType>Наличными</paymentType>
<deliveryType>Доставка курьером</deliveryType>
<priceRUB>691.00</priceRUB>
<items>
<item id="68534240">
<external_id>717432</external_id>
<name>Hama H-74229 hdmi 1.3 a-c (mini)</name>
<quantity>1.00</quantity>
<currency>RUB</currency>
<image>http://images.ru.prom.st/hama-h-74229.jpg</image>
<url>http://example-shop.tiu.ru/hama-h-74229</url>
<price>366.00</price>
<sku/>
</item>
<item id="68534241">
<external_id>717436</external_id>
<name>Hama H-74237 hdmi 1.3 a-c (mini)</name>
<quantity>1.00</quantity>
<currency>RUB</currency>
<image>http://images.ru.prom.st/hama-h-74237.jpg</image>
<url>http://example-shop.tiu.ru/hama-h-74237</url>
<price>325.00</price>
<sku/>
</item>
</items>
</order>
</orders>
```
####Поля:
* атрибут `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)

55
config/config-dist.php
View File

@ -1,39 +1,48 @@
<?php
$сonfig = array(
// ссылка вида https://my.tiu.ru/cabinet/export_orders/xml/1234567?hash_tag=472g8fzb1af38d35f2c521dc8a1e1208
// берется отсюда: https://my.tiu.ru/cabinet/order/export_orders
/**
* xml link (like https://my.tiu.ru/cabinet/export_orders/xml/1234567?hash_tag=472g8fzb1af38d35f2c521dc8a1e1208)
* can be taken here: https://my.tiu.ru/cabinet/order/export_orders
*/
'tiu_xml_url' => '',
'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'
);
/**
* email address for notification
*/
'support_email' => 'support@example.org',
'support_email_subject' => 'Integration problem'
);

0
logs/.gitkeep
View File