Wiki - Новые страницы [ru]

Импорт прайс-листов

2019-02-20T07:52:29Z

ASLezhnin: Новая страница: «Category:API интеграции с учетной системой API интеграции с учетной системой<syntaxhighlight lang="xml…»

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<back_to_ef dateuploading="2010-10-30 15:00:00" org_name="Company">

<save_price_list
name = "Акция"
ext_code = "001"
range = "1"
active = "true"
start_date = "2010-01-01"
finish_date = "2020-01-01"
use_finish_date = "true"
use_stores = "true">

<stores>

<store code="1"/>
<store code="2"/>
</stores>

<prices>

<price barcode="1212323" value="10.1"/>
<price barcode="5342344" value="100"/>
</prices>
</save_price_list>


<remove_price_list ext_code="0002"/>
</back_to_ef>
</syntaxhighlight>

Импорт справочника марок ЕГАИС со справкой 2

2018-12-13T12:58:00Z

ASLezhnin:

Запрос на подтверждение статуса "оплачено" для транзакции гостиничной системы

2018-09-24T07:41:28Z

ASLezhnin: Новая страница: «Category:API интеграции с учетной системой API интеграции с учетной системой {|class="wikitable" |С…»

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_set_ext_sys_trx_paid
|-
|Параметры
|
* check_num- UID чека
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_set_ext_sys_trx_paid?check_num=29123123124231
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response datetime="2015-07-27 15:16:39">
<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос отмены заказа на будущую дату (WEB интерфейс)

2018-07-09T12:03:52Z

ASLezhnin: Новая страница: «Category:API для для работы с заказом через WEB интерфейс API для работы с заказом через WEB инт…»

[[Category:API для для работы с заказом через WEB интерфейс]]
[[API для работы с заказом через WEB интерфейс]]
{|class="wikitable"
|Страница
|dh_cancel_order
|-
|Параметры
|
* uid – код карты;
* d - дата в формате YYYY-MM-DD;
* id_food_intake - ID смены питания;

|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>dh_cancel_order?uid=09-0001&d=2011-09-01&password=123456&id_food_intake=1
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>

<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос на получение заказов за период (WEB интерфейс)

2018-07-09T11:30:55Z

ASLezhnin:

[[Category:API для для работы с заказом через WEB интерфейс]]
[[API для работы с заказом через WEB интерфейс]]
{|class="wikitable"
|Страница
|dh_period_orders
|-
|Параметры
|
* uid – код карты
* s - дата начала периода в формате YYYY-MM-DD
* f - дата конца периода в формате YYYY-MM-DD
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>dh_period_orders?uid=09-0001&s=2011-09-01&f=2011-09-02&password=123456
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>

<result>ok</result>

<day date="2011-09-01">

<food_intake name="Завтрак" cost="20" id_complex="2" id_food_intake="1">
<item name="Суп1" quantity="1" unit="порц."/>
<item name="Чай" quantity="0.3" unit="л"/>
<item name="Хлеб" quantity="2" unit="кус."/>
</food_intake>
<food_intake name="Обед" cost="30" id_complex="3" id_food_intake="2">
<item name="Суп1" quantity="1" unit="порц."/>
<item name="Чай" quantity="0.3" unit="л"/>
<item name="Хлеб" quantity="2" unit="кус."/>
</food_intake>
</day>
<day date="2011-09-02">

<food_intake name="Завтрак" cost="20" id_complex="4" id_food_intake="1">
<item name="Суп1" quantity="1" unit="порц."/>
<item name="Чай" quantity="0.3" unit="л"/>
<item name="Хлеб" quantity="2" unit="кус."/>
</food_intake>
<food_intake name="Обед" cost="30" id_complex="5" id_food_intake="2">
<item name="Суп1" quantity="1" unit="порц."/>
<item name="Чай" quantity="0.3" unit="л"/>
<item name="Хлеб" quantity="2" unit="кус."/>
</food_intake>
</day>
</response>
</syntaxhighlight>
|}

Импорт справочника рабочих мест

2018-06-21T06:49:23Z

ASLezhnin: Новая страница: «Category:API интеграции с учетной системой API интеграции с учетной системой <syntaxhighlight lang="x…»

Запрос на получение времени работы магазина

2018-03-12T10:54:36Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_store_work_time
|-
|Параметры
|
* org - Код организации (Обязательный параметр);
* sd - Дата начала периода в формате YYYYMMDD (Необязательный параметр, по умолчанию текущая дата);
* fd - Дата завершения периода в формате YYYYMMDD (Необязательный параметр, по умолчанию текущая дата);
* store_filter - * - Все места хранения | иначе передаются коды мест хранения через ";" (Необязательный параметр, по умолчанию - *)
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_store_work_time?org=1&sd=20101010&fd=20101010&store_filter=*
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response datetime="2017-12-16 20:15:07">
<result>ok</result>
<items>
<item store_name="Магазин №1" store_code="001" start_datetime="2010-10-10 08:00:00" finish_datetime="2010-10-10 19:00:00"/>
<item store_name="Магазин №2" store_code="002" start_datetime="2010-10-10 08:01:00" finish_datetime="2010-10-10 18:00:00"/>
</items>
</response>
</syntaxhighlight>
|}

Запрос на получение справочника номенклатуры

2018-02-08T13:22:43Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_full_inventory_items
|-
|Параметры
|
org – Имя или код организации
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_full_inventory_items?org=Перекресток
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>

<result>ok</result>

<nom_group name="Гарниры" code="00000000678" parentcode="" sort_index="1"/>
<nom_group name="Гарниры из круп, бобовых и макаронных изделий"
code="00000002461"
parentcode="00000000678"
sort_index="2"/>

<nom_element name="Гречка рассыпчатая"
code="00000005853"
parentcode="00000002461"
unit="пор"
type="Блюдо"
description="Гречка рассыпчатая"
receipt=""
category="Блюда"
tax_uid="001"
fz54_tax_index="1" >

<price store="Столовая 1" store_code="123123" value="9.10"/>
<price store="Столовая 2" value="9.70" date="2017-10-01"/>

<addbarcode value="123123123" quantity="0.5"/>
<addbarcode value="123123125"/>


<egais_item producer_reg_id="14132423"
full_name="Алкоголь"
short_name="Алк."
alc_code="23487234"
capacity="0.7000"
alc_volume="40.0000"
productvcode="200"/>


<print_directions>

<print_direction direction_code="БАР 1 ЭТАЖ"/>
<print_direction direction_code="БАР 2 ЭТАЖ"/>
</print_directions>
</nom_element>


<nom_image code="00000005853"
file_name="1.jpg"
md5="10983190238091273123123"
type="jpg">
YXNkbGZqc3psZnpubGFrc2prZGFzZGFzZnNhZGZzYWRmc2FkZnNhZGZzZGZzYWRm...
</nom_image>
</response>
</syntaxhighlight>
|}

Установка признака, что документ загружен в бек (Вариант 2)

2018-01-15T11:48:41Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_confirm_uploading_document
|-
|Параметры
|
* uid - UID документа
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_confirm_uploading_document?uid={C2310303-3328-43D2-859D-A14FAAAF9BDB}
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response datetime="2015-07-27 15:16:39">
<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос на получение количества продаж за дату

2017-12-21T19:44:27Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_sale_items_by_date
|-
|Параметры
|
* org - Код организации
* date - Дата в формате YYYY-MM-DD
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_sale_items_by_date?org=1&date=2017-07-21
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response datetime="2017-12-16 20:15:07">
<result>ok</result>
<items nom_name="Гуляш с рисом" barcode="00000000217" qty="2" uom="пор"/>
<items nom_name="Колбаса вареная" barcode="00000000261" qty="2" uom="кг"/>
<items nom_name="Коржики 2" barcode="000013094" qty="1" uom="шт"/>
</response>
</syntaxhighlight>
|}

Запрос на получение статистики по сменам касс за дату

2017-12-16T17:18:09Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_ccr_sales_by_date
|-
|Параметры
|
* org - Код организации
* date - Дата в формате YYYY-MM-DD
* hide_empty - Скрывать кассы с нулевыми суммами за дату (Логическое значение 1/0)
* group_by_store - Группировать по местам хранения (Логическое значение 1/0)
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_ccr_sales_by_date?org=1&date=2017-07-21&hide_empty=1&group_by_store=1
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response datetime="2017-12-16 20:15:07">
<result>ok</result>
<ccr_date dev_name="CCR1" cash="513.8" bank_card="0" store_code="1"/>
<ccr_date dev_name="CCR2" cash="900" bank_card="20" store_code="2"/>
</response>
</syntaxhighlight>
|}

Импорт поставщиков

2017-09-06T09:29:29Z

ASLezhnin:

Импорт справочника вспомогательного персонала

2017-06-01T13:36:59Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<back_to_ef dateuploading="2010-10-30 15:00:00" org_name="Company">

<save_employee name="Смирнова А.А."
inn="11231231238"
employee_type="1"
pin="1234"
uid="c9bce012-26e1-476b-a02f-c22399e2348f"
active="1"
tab_num="22"
pasport_date="2010-10-10"
pasport_seria="8888"
pasport_num="12345678"
pasport_source="ОМ УВД"/>


<remove_employee uid="c9bce012-26e1-476b-a02f-c22399e2348f"/>
</back_to_ef>
</syntaxhighlight>

Запрос на установку флага выгруженности РКО

2017-06-01T13:14:34Z

ASLezhnin: Новая страница: «Category:API интеграции с учетной системой API интеграции с учетной системой {|class="wikitable" |С…»

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_confirm_rko
|-
|Параметры
|
* uid - ID записи РКО
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_confirm_rko?uid=12312423423
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос на получение справочника РКО

2017-06-01T12:27:46Z

ASLezhnin:

Запрос возвращает список журнала РКО
{|class="wikitable"
|Страница
|xml_rkos
|-
|Параметры
|
* org - Наименование или код организации
* st - Начало периода (в формате yyyymmddhhnnss)
* ft - Конец периода (в формате yyyymmddhhnnss)
* only_new - Логический признак - показывать только не загруженные в бек записи РКО (1 или 0)
|-
|Пример запроса
|<nowiki>http://hostname:9870/</nowiki>xml_rkos?org=Company&st=20150910100000&ft=20150912200000
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response datetime="2015-03-17 12:08:59">
<result>ok</result>
<rkos>

<rko_manager uid="{ec82f1fd-24e3-4d85-bb60-0bb41128f615}"
value="10000"
user_inn="132810923123"
user_name="Иванов И.И."
user_code="123"
store_code="001"
store_name="Склад - Магазин №1"
comp_code="001"
comp_name="Магазин №1"
kkm_code="1001"
kkm_name="Касса Магазин 1"
datetime="2010-10-10 10:00:00"
doc_date="2010-10-10"
manager_inn="2093840238432"
manager_name="Иванов И.И."
manager_uid="12218371982379123"
unloaded="1" />

<rko_incashier uid="{fd85f1fd-24e3-4d85-bb60-0bb41128f615}"
value="10000"
user_inn="132810923123"
user_name="Иванов И.И."
user_code="123"
store_code="001"
store_name="Склад - Магазин №1"
comp_code="001"
comp_name="Магазин №1"
bag_num="123123"
datetime="2010-10-10 10:00:00"
doc_date="2010-10-10"
unloaded="1"/>


<rko_user uid="{AB82f1fd-24e3-4d85-bb60-0bb41128f615}"
value="10000"
user_inn="132810923123"
user_name="Иванов И.И."
user_code="123"
store_code="001"
store_name="Склад - Магазин №1"
comp_code="001"
comp_name="Магазин №1"
datetime="2010-10-10 10:00:00"
doc_date="2010-10-10"
target_user_inn="2093840238432"
target_user_name="Иванов И.И."
target_user_code="123"
unloaded="1"/>
</rkos>
</response>
</syntaxhighlight>
|}

Запрос на получение списка актов внесения и изъятия за период

2017-02-14T20:15:06Z

ASLezhnin: Новая страница: «Category:API интеграции с учетной системой API интеграции с учетной системой {|class="wikitable" |С…»

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_income_outcomes
|-
|Параметры
|
* sd - Дата начала периода (в формате YYYYMMDD)
* fd - Дата окончания периода (в формате YYYYMMDD)
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_income_outcomes?sd=20150601&fd=20150601
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response>
<cash_operations>
<operation type="outcome" value="68000" datetime="2017-02-11 06:18:14"
ccr_name="Касса Магазин Кирово-Чепецк 6"
store_name="Кирово-Чепецк-6, Островского ул, 11"
store_code="306"
ccr_code="474"/>
</cash_operations>
</response>
</syntaxhighlight>
|}

Список чеков за смену

2017-01-24T08:40:52Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_sessions_checks
|-
|Параметры
|
* S1 – Id первой смены в запросе
* S2 – Id второй смены в запросе
* SN – Id N-ой смены в запросе
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_sessions_checks?s1=1&s2=3&s3=34&s4=36
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response datetime="2015-03-17 12:08:59">
<result>ok</result>

<check cashier_name="SUPERVISOR"
datetime="2014-07-21 15:39:58"
device_name="Касса 1"
pt_cash="258"
pt_bank_card="0"
pt_present="0"
pt_bonus="0"
pt_external="0"
pt_talon="0"
pt_clubcard="0"
pt_moneta="0"
change="0"
bonus_val="0"
is_sale="1"
check_num="2900100124409"
fr_session="7"
fr_number="88"
id_session="94"
waiter_name="SUPERVISOR"
table="№2"
room="Зал"
discount_card="3334444"
ds_customer_group="VIP"
ds_customer="Иванов И.И."
ds_customer_code="34555">

<position name="Бизнес-ланч"
unit="шт"
type="Блюдо"
type_index="2"
quantity="1"
price="8"
barcode="00000000275"
discount="0"
store_name="Бар"
discount_name="Нет"
parent_code="00000000203">
<modifier name="Суп"
unit="шт"
barcode="00000000479"
quantity="1"
type="Товар"
type_index="3"/>
</position>
<position name="Батон к чаю"
unit="шт"
type="Блюдо"
type_index="2"
quantity="1"
price="20"
barcode="00000000204"
discount="0"
store_name="Бар"
discount_name="Нет"
parent_code="00000000203"/>
<position name="Пирог с мясом и капустой 1 кг"
unit="кг"
type="Блюдо"
type_index="2"
quantity="1"
price="230"
barcode="00000000469"
discount="0"
store_name="Бар"
discount_name="Нет"
parent_code="00000000203"/>
</check>
</response>
</syntaxhighlight>
|}

Проверка наличия необходимых настроек для внешней системы в БИТ Аппетит

2017-01-13T08:08:09Z

ASLezhnin:

{|class="wikitable"
|Страница
|eps_check_settings
|-
|Параметры
| org_code - код организации
|-
|Пример запроса
|<nowiki>http://hostname:9870/</nowiki>eps_check_settings
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|}

Импорт направлений печати

2016-11-29T06:38:37Z

ASLezhnin: Новая страница: «Category:API интеграции с учетной системой API интеграции с учетной системой <syntaxhighlight lang="x…»

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<back_to_ef dateuploading="2010-10-30 15:00:00" org_name="Company">

<nom_printer printer="001" barcode="123123123"/>
</back_to_ef>
</syntaxhighlight>

Запрос на получение журнала открытия бутылок

2016-11-23T08:08:26Z

ASLezhnin:

Запрос возвращает журнал открытия бутылок за период
{|class="wikitable"
|Страница
|xml_bottle_opens
|-
|Параметры
|
* org - Наименование или код организации
* st - Начало периода (в формате yyyymmddhhnnss)
* ft - Конец периода (в формате yyyymmddhhnnss)
|-
|Пример запроса
|<nowiki>http://hostname:9870/</nowiki>xml_bottle_opens?org=Company&st=20150910100000&ft=20150912200000
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response datetime="2015-03-17 12:08:59">
<result>ok</result>
<bottle_opens>

<bottle_open uid="{ec82f1fd-24e3-4d85-bb60-0bb41128f615}"
store_code="001"
datetime="2010-10-10 10:00:00"
nom_code="123123123"
barcode="4242133123123"
egais_code="7283233231231313142534242345345245234234"
alcocode="123143213123123"
qty="1"
used="true"/>
<bottle_open uid="{ec82f1fd-24e3-4d85-bb60-0bb41128f616}"
store_code="001"
datetime="2010-10-10 10:00:00"
nom_code="4565462342"
barcode="463563463465"
egais_code=""
alcocode="123143213124323"
qty="10"
used="false"/>
</bottle_opens>
</response>
</syntaxhighlight>
|}

Получение меню ресторана (ВПС)

2016-11-09T09:05:56Z

ASLezhnin:

{|class="wikitable"
|Страница
|eps_menu
|-
|Параметры
| org_code - код организации
|-
|Пример запроса
|<nowiki>http://hostname:9870/</nowiki>eps_menu?org_code=1231
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>

<menus>

<menu id="1" name="Бар">
<menus>
<menu id="4" name="Пиво">

<menu_items>

<menu_item id="1"
name="Пиво"
unit="бутылка"
description="">
<menu_item/>
<menu_items/>
</menu>
</menus>
<menu_items>
<menu_item id="1" name="Абсент Ксента"
unit="бутылка"
description="Замечательный напиток">
<menu_item/>
<menu_items/>
<menu/>
<menu id="2" name="Супы"/>
<menu id="3" name="Вторые блюда"/>
<menus/>
</response>
</syntaxhighlight>
|}

Запрос на получение количества новых заявок с сервиса WEB доставки

2016-10-19T08:49:17Z

ASLezhnin: Новая страница: «{|class="wikitable" |Страница |/get_new_orders_count |- |Параметры | * login - Логин для доступа к сервису * passwo…»

{|class="wikitable"
|Страница
|/get_new_orders_count
|-
|Параметры
|
* login - Логин для доступа к сервису
* password - Пароль для доступа к сервису
* id_restaurant - Код ресторана
|-
|Пример запроса
|<nowiki>http://hostname:3882/api/</nowiki>get_new_orders_count?login=1&password=1?id_restaurant=0001
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
<new_orders_count>10</new_orders_count>
</response>
</syntaxhighlight>
|}

Импорт налоговых ставок

2016-09-09T12:02:55Z

ASLezhnin:

Запрос на удаление позиции заказа

2016-08-08T06:44:52Z

ASLezhnin:

[[Category:API для "Мобильного официанта"]]
[[API для "Мобильного официанта"]]

{|class="wikitable"
|Страница
|wt_remove_order_position
|-
|Параметры
|
* did - ID устройства
* id_order_postion - ID позиции
* id_user - ID пользователя
|-
|Пример запроса
|<nowiki>http://hostname:9870/</nowiki>wt_remove_order_position?did=1&id_order_postion=100&id_user=1
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос на получение списка транзакций клубных карт

2016-08-08T06:04:55Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

Метод возвращает список контрагентов, с подчиненным списком транзакций зарегистрированных в БД.
Список транзакций, возвращается согласно установленным параметрам временного фильтра "sd" и "fd".
Запрос может использоваться, как отчет сверки по операциям контрагентам

{|class="wikitable"
|Страница
|xml_get_customers_trxs
|-
|Параметры
|
* sd – начало периода. Дата в формате yyyymmdd.
* fd – конец периода. Дата в формате yyyymmdd.
* cids - список ID контрагентов, разделенных ";". При передачи значения "*" будет выдан ответ по всем операциям, контрагентов в этот день.

|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_get_customers_trxs?sd=2010-01-01&fd=2010-01-10&cids=001;002;003;004
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>

<result>ok</result>

<customers>

<customer ext_code="001"
name="Иванов"
balance="200">

<trx value="100"
trx_uid="{b36f24a9-87fd-473d-84ff-45e46f0a2dc2}"
dttm="2010-10-10 10:10:10"
type_index="2"
new_balance="200"/>
</customer>
</customers>
</response>
</syntaxhighlight>
|}

Запрос на отправку подтверждения об изменении баланса контрагента

2016-08-04T07:25:12Z

ASLezhnin:

{|class="wikitable"
|Страница
|/proc_payment
|-
|Параметры
|
* login - Логин для доступа к сервису
* password - Пароль для доступа к сервису
* customer_code - Код контрагента
* value - Сумма операции в копейках (положительное значение - пополнение средств, отрицательное списание)
* dttm - Дата время операции в формате yyyymmddhhnnss
* trx_uid - Уникальный код транзакции в формате GUID
* type_index - Тип операции:
0-Списание с карты за питание 
1-Пополнение баланса наличными на кассе 
2-Пополнение безналичным 
3-Пополнение с внешней системы 
4-Списание с клубной карты 
5-Возврат на клубную карту 
6-Возврат за отказ питания 
7-Списание средств при переводе 
8-Пополнение средств при переводе )

* meta - Строка содержащая XML структуру, закодированная в BASE64. В структуре передается дополнительная аналитика по связанным с транзакцией данными.

|-
|Пример запроса
|<nowiki>http://hostname:3882/api/</nowiki>proc_payment?login=1&password=1&customer_code=002&value=-10000&trx_uid={b36f24a9-87fd-473d-84ff-45e46f0a2dc2}&type_index=0
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|-
|
|-
|Пример заполнения XML данных в параметре meta. Передача данных о зарегистрированном комплексе на раздаче столовой.
|<syntaxhighlight lang="xml">
<meta>

<complex food_intake_code="001" complex_code="002" total_benefit="10">

<categories>

<category code="001"/>
<category code="002"/>
</categories>

<items>
<item code="3123123" qty="1" price="50" benefit="10"/>
<item code="8293480" qty="1" price="60" benifit="0"/>
</items>

</complex>
</meta>
</syntaxhighlight>
|-
|Пример заполнения XML данных в параметре meta. Передача данных о зарегистрированной покупке в буфете.
|<syntaxhighlight lang="xml">
<meta>

<sale>

<item code="3123123" qty="1" price="50"/>
<item code="8293480" qty="1" price="60"/>
</sale>
</meta>
</syntaxhighlight>

|}

Запрос на отправку текстового сообщения внешнему серверу столовой

2016-08-02T14:29:23Z

ASLezhnin:

{|class="wikitable"
|Страница
|/proc_text_message
|-
|Параметры
|
* login - Логин для доступа к сервису
* password - Пароль для доступа к сервису
* customer_code - Код контрагента с которым ассоциировано сообщение
* content - Текст сообщения кодированный в кодировке base64
|-
|Пример запроса
|<nowiki>http://hostname:3882/api/</nowiki>proc_text_message?login=1&password=1&customer_code=200&content=dGVzdA++
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|}

Общий принцип обмена данными БИТ Аппетита с внешним сервером столовой

2016-08-02T14:14:10Z

ASLezhnin:

В данной схеме интеграции БИТ Аппетит выступает в качестве клиента, который инициирует обмен данными по средствам HTTP запросов к внешнему серверу столовой. Таким образом на стороне сервера должна быть реализована обработка запросов, по которым БИТ Аппетит периодически обращается к нему.

== Формат HTTP запросов ==
Запросы, которые осуществляет БИТ Аппетит, представляют собой GET/POST запросы следующего вида: 
<nowiki>http(s)://{host}:{port}/{page_prefix}{page}{page_suffix}?{parameter1}={value1}&{parameter2}={value2} ... {parameterN}={valueN}</nowiki>

Где параметры имеют следующие значения
* host - сетевой адрес
* port - порт tcp/ip порт соединения (80 по умолчанию)
* page_prefix - путь к странице
* page - наименование страницы (метод API)
* page_suffix - суффикс страницы (например расширение .php или .html)
* parameterN - имя параметра
* valueN - значение параметра.

Для передачи параметров содержащих XML структуру предварительно используется кодирование строки в BASE64.

== Общий вид ответов ==
Взаимодействие сервера БИТ Аппетита(клиент) с внешним сервером происходит в виде серии GET/POST запросов.
Каждый метод для работы с API определяется URL (страницей на сервере), параметрами (соответствуют параметрам GET/POST) и ответом.
Ответ представляет собой текст, содержащий данные в формате XML. 

Общий вид ответа в случае успеха:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>ok</result>
...Данные...
</response>
</syntaxhighlight>

В случае ошибки на сервере:
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response>
<result>error</result>
<description>{Error description}</description>
<error_code>{Error num}</error_code>
</response>
</syntaxhighlight>

API для внешнего сервера столовой

2016-08-02T14:12:15Z

ASLezhnin: Новая страница: «#Общий принцип обмена данными БИТ Аппетита с внешним сервером столовой #Запрос на отп…»

#[[Общий принцип обмена данными БИТ Аппетита с внешним сервером столовой]]
#[[Запрос на отправку текстового сообщения внешнему серверу столовой]]
#[[Запрос на отправку подтверждения об изменении баланса контрагента]]

Импорт категорий контрагентов

2016-08-01T14:33:00Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<back_to_ef dateuploading="2010-10-30 15:00:00" org_name="Company">

<save_customer_category
name="Льготники"
ext_code="001">

<benefit food_intake_code="001"
mon_value="0" mon_type="0"
tue_value="10" tue_type="1"
wed_value="0" wed_type="1"
thu_value="50" thu_type="1"
fri_value="100" fri_type="0"
sat_value="0" sat_type="1"
sun_value="0" sun_type="1 />
<benefit food_intake_code="002"
mon_value="0" mon_type="0"
tue_value="10" tue_type="1"
wed_value="0" wed_type="1"
thu_value="50" thu_type="1"
fri_value="100" fri_type="0"
sat_value="0" sat_type="1"
sun_value="0" sun_type="1 />
</save_customer_category>


<remove_customer_category ext_code="001"/>
</back_to_ef>
</syntaxhighlight>

Импорт смен питания столовой

2016-07-27T08:59:11Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<back_to_ef dateuploading="2010-10-30 15:00:00" org_name="Company">


<save_food_intake
ext_code="001"
name="Завтрак"
mon="true"
tue="true"
wed="true"
thu="true"
fri="true"
sat="false"
sun="false"
start_time="08:00:00"
finish_time="10:00:00"
store_code="002"/>


<remove_food_intake ext_code="001"/>
</back_to_ef>
</syntaxhighlight>

Импорт заявок комплексов столовой

2016-07-27T08:49:24Z

ASLezhnin:

Импорт комплексов столовой

2016-07-27T08:32:50Z

ASLezhnin:

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<back_to_ef dateuploading="2010-10-30 15:00:00" org_name="Company">

<save_complex name="Завтрак Понедельник №1"
short_name="ЗП1"
fix_price="100"
ext_code="0001">

<item code="123123123" qty="1"/>
<item code="426347862" qty="0.5"/>
</save_complex>

<remove_complex ext_code="0002"/>
</back_to_ef>
</syntaxhighlight>

Импорт производителей ЕГАИС

2016-06-30T08:29:46Z

ASLezhnin:

Запрос на установку статуса заявки в сервисе WEB доставки

2016-06-01T13:33:44Z

ASLezhnin:

{|class="wikitable"
|Страница
|/set_status_order
|-
|Параметры
|
* login - Логин для доступа к сервису
* password - Пароль для доступа к сервису
* uid - Уникальный ID заявки
* status - Код статуса обработки заявки, может принимать следующие значения
* id_restaurant - Код ресторана
{0-Передано в ресторанную систему;1-Готовится;2-Готово;3-Доставляется;4-Доставлено}

|-
|Пример запроса
|<nowiki>http://hostname:3882/api/</nowiki>set_status_order?login=1&password=1=&uid=b4f73277-2857-4527-a0ad-d9812ac88563&status=2&id_restaurant=0001
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос на регистрацию передачи заявки из сервиса WEB доставки в ресторанную систему

2016-06-01T13:30:34Z

ASLezhnin:

После вызова POS системой метода "register_order" заказ должен исключаться из выдачи по запросам get_new_orders и get_new_orders_count.

{|class="wikitable"
|Страница
|/register_order
|-
|Параметры
|
* login - Логин для доступа к сервису
* password - Пароль для доступа к сервису
* uid - Уникальный ID заявки
* id_restaurant - Код ресторана
|-
|Пример запроса
|<nowiki>http://hostname:3882/api/</nowiki>register_order?login=1&password=1=&uid=b4f73277-2857-4527-a0ad-d9812ac88563?id_restaurant=0001
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос на получение состава заявки с сервиса WEB доставки

2016-06-01T13:28:13Z

ASLezhnin:

{|class="wikitable"
|Страница
|/get_order_content
|-
|Параметры
|
* login - Логин для доступа к сервису
* password - Пароль для доступа к сервису
* uid - Уникальный ID заявки
|-
|Пример запроса
|<nowiki>http://hostname:3882/api/</nowiki>get_order_content?login=1&password=1=&uid=b4f73277-2857-4527-a0ad-d9812ac88563
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>

<order uid="b4f73277-2857-4527-a0ad-d9812ac88563"
description="Описание"
dicsount_card="123123">

<item code="23131231232" price="50" name="Роллы Калифорния" quantity="2"/>
<item code="31351231543" price="100" name="Сок" quantity="1"/>
</order>
</response>
</syntaxhighlight>
|}

Запрос на получение списка заявок с сервиса WEB доставки

2016-06-01T13:17:42Z

ASLezhnin:

{|class="wikitable"
|Страница
|/get_new_orders
|-
|Параметры
|
* login - Логин для доступа к сервису
* password - Пароль для доступа к сервису
* id_restaurant - Код ресторана
|-
|Пример запроса
|<nowiki>http://hostname:3882/api/</nowiki>get_new_orders?login=1&password=1?id_restaurant=0001
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
<new_orders>

<new_order uid="ebbbef8d-678d-4c0a-ab51-4eb0f8f5563e"
sum="2000"
description="Описание"
payment_type="0"
create_datetime="2017-01-01 10:10:00"
delivery_datetime="2017-01-01 15:10:00"
dicsount_card="123123"
type="0"
locality="Москва"
street="Ленинградский проспект"
house="30"
building=""
flat="20"
entree="1"
phone="1283182937"
email="a@a.com"
floor="2"
>

<item code="23131231232" price="50" name="Роллы Калифорния" quantity="2"/>
<item code="31351231543" price="100" name="Сок" quantity="1"/>
</new_order>
<new_order uid="b4f73277-2857-4527-a0ad-d9812ac88563" sum="1000" description="Описание" payment_type="1">
<item code="23131231232" price="50" name="Роллы Калифорния" quantity="2"/>
<item code="31351231543" price="100" name="Сок" quantity="1"/>
</new_order>
</new_orders>
</response>
</syntaxhighlight>
|}

Общий принцип обмена данными БИТ Аппетита с сервисом WEB доставки

2016-05-11T12:03:53Z

ASLezhnin:

В данной схеме интеграции БИТ Аппетит выступает в качестве клиента, который инициирует обмен данными по средствам HTTP запросов к серверу сервиса доставки. Таким образом на стороне сервера должна быть реализована обработка запросов, которые БИТ Аппетит периодически отправляет к нему.
Этот подход к построению обмена позволяет на одном сервере интернет доставки обслуживать работу нескольких ресторанов с автономной установкой БИТ Аппетита.

Обмен данными условно можно разделить на 2 типа запросов:
* Отправка справочных данных.
* Передача заявки на доставку в БИТ Аппетит.

== Формат HTTP запросов ==
Запросы, которые осуществляет БИТ Аппетит, представляют собой GET/POST запросы следующего вида: 
<nowiki>http(s)://{host}:{port}/{page_prefix}{page}{page_suffix}?{parameter1}={value1}&{parameter2}={value2} ... {parameterN}={valueN}</nowiki>

Статус HTTP ответа в случае ошибки должен быть 200.

Где параметры имеют следующие значения
* host - сетевой адрес
* port - порт tcp/ip порт соединения (80 по умолчанию)
* page_prefix - путь к странице
* page - наименование страницы (метод API)
* page_suffix - суффикс страницы (например расширение .php или .html)
* parameterN - имя параметра
* valueN - значение параметра.

Для передачи параметров содержащих XML структуру предварительно используется кодирование строки в BASE64.

API для внешней системы доставки

2016-05-11T11:48:15Z

ASLezhnin:

#[[Общий принцип обмена данными БИТ Аппетита с сервисом WEB доставки]]
#[[Запрос на получение количества новых заявок с сервиса WEB доставки]]
#[[Запрос на получение списка заявок с сервиса WEB доставки]]
#[[Запрос на регистрацию передачи заявки из сервиса WEB доставки в ресторанную систему]]
#[[Запрос на установку статуса заявки в сервисе WEB доставки]]

Запрос на отправку печати нераспечатанной позиции заказа (МО)

2016-05-11T11:33:13Z

ASLezhnin: Новая страница: «Category:API для "Мобильного официанта" API для "Мобильного официанта" {|class="wikitable" |Страница…»

[[Category:API для "Мобильного официанта"]]
[[API для "Мобильного официанта"]]

{|class="wikitable"
|Страница
|wt_print_order_position
|-
|Параметры
|
* did - ID устройства
* id_order_postion - ID позиции
|-
|Пример запроса
|<nowiki>http://hostname:9870/</nowiki>wt_print_order_position?did=1&id_order_postion=100
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос на удаление нераспечатанной позиции заказа (МО)

2016-05-11T11:28:14Z

ASLezhnin: Новая страница: «Category:API для "Мобильного официанта" API для "Мобильного официанта" {|class="wikitable" |Страница…»

[[Category:API для "Мобильного официанта"]]
[[API для "Мобильного официанта"]]

{|class="wikitable"
|Страница
|wt_remove_order_position
|-
|Параметры
|
* did - ID устройства
* id_order_postion - ID позиции
|-
|Пример запроса
|<nowiki>http://hostname:9870/</nowiki>wt_remove_order_position?did=1&id_order_postion=100
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<response>
<result>ok</result>
</response>
</syntaxhighlight>
|}

Запрос на подтверждение обработки заявки

2016-03-01T12:57:02Z

ASLezhnin: Новая страница: «Category:API интеграции с учетной системой API интеграции с учетной системой {|class="wikitable" |С…»

[[Category:API интеграции с учетной системой]]
[[API интеграции с учетной системой]]

{|class="wikitable"
|Страница
|xml_confirm_product_order
|-
|Параметры
|
* id - уникальный идентификатор заявки
|-
|Пример запроса
|<nowiki>http://localhost:9870/</nowiki>xml_confirm_product_order?id=2121
|-
|Пример ответа
|<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response datetime="2015-07-27 15:16:39">
<result>ok</result>
</response>
</syntaxhighlight>
|}