мета-данные страницы
Различия
Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия Следующая версия Следующая версия справа и слева | ||
commercial_api [15.02.2024 14:38] FeLDMaRShaL |
commercial_api [24.04.2024 13:54] Anatoly |
||
---|---|---|---|
Строка 3: | Строка 3: | ||
==== Описание API ==== | ==== Описание API ==== | ||
- | %%API%% позволяет реализовать создание и редактирование заказов, добавление оплаты в заказ, создание и изменение клиентов, получение изменившихся заказов и клиентов и др. | + | %%API%% позволяет реализовать создание и редактирование заказов, добавление оплаты в заказ, создание и изменение клиентов, получение изменившихся заказов и клиентов и др. |
---- | ---- | ||
==== Схема работы API ==== | ==== Схема работы API ==== | ||
{{:работа_api.drawio.png?direct&600 |}}\\ | {{:работа_api.drawio.png?direct&600 |}}\\ | ||
- | + | ---- | |
- | === Формат команд === | + | ==== Формат команд ==== |
- | Все значения параметров команд должны быть преобразованы, **через js encodeURIComponent или подобные функции**. | + | Все значения параметров команд должны быть преобразованы, **через js encodeURIComponent, через php urlencode или подобные функции**. |
**Пример:** | **Пример:** | ||
Строка 66: | Строка 66: | ||
---- | ---- | ||
==== Работа с заказами ==== | ==== Работа с заказами ==== | ||
- | |||
[[#Сохранение заказа. SaveOrderForAll|Сохранение заказа. SaveOrderForAll]]\\ | [[#Сохранение заказа. SaveOrderForAll|Сохранение заказа. SaveOrderForAll]]\\ | ||
[[#Изменение заказа. UpdateOrderForAll|Изменение заказа. UpdateOrderForAll]]\\ | [[#Изменение заказа. UpdateOrderForAll|Изменение заказа. UpdateOrderForAll]]\\ | ||
Строка 76: | Строка 75: | ||
[[#Квитанция. ReceiptOnline|Квитанция. ReceiptOnline]]\\ | [[#Квитанция. ReceiptOnline|Квитанция. ReceiptOnline]]\\ | ||
[[#Список заказов за период. OrdersBetweenForAll|Список заказов за период. OrdersBetweenForAll]]\\ | [[#Список заказов за период. OrdersBetweenForAll|Список заказов за период. OrdersBetweenForAll]]\\ | ||
+ | [[api#фотографии_по_заказу_photoonline|Фотографии по заказу. PhotoOnline]]. | ||
---- | ---- | ||
==== Работа с услугами ==== | ==== Работа с услугами ==== | ||
- | [[#Получение фотографий услуг. GetOrderImagesForAll|Получение фотографий услуг. GetOrderImagesForAll]]\\ | ||
[[#Сохранение фотографии в услуге. SetOrderImagesForAll|Сохранение фотографии в услуге. SetOrderImagesForAll]]\\ | [[#Сохранение фотографии в услуге. SetOrderImagesForAll|Сохранение фотографии в услуге. SetOrderImagesForAll]]\\ | ||
[[#Накладные в пути. DocsInWayBetweenForAll|Накладные в пути. DocsInWayBetweenForAll]]\\ | [[#Накладные в пути. DocsInWayBetweenForAll|Накладные в пути. DocsInWayBetweenForAll]]\\ | ||
Строка 94: | Строка 92: | ||
[[#Список изменившихся ID заказов. LastChangeOrder|Список изменившихся ID заказов. LastChangeOrder]]\\ | [[#Список изменившихся ID заказов. LastChangeOrder|Список изменившихся ID заказов. LastChangeOrder]]\\ | ||
---- | ---- | ||
+ | ==== Устаревшие команды ==== | ||
+ | [[#Получение фотографий услуг. GetOrderImagesForAll|Получение фотографий услуг. GetOrderImagesForAll]]\\ | ||
---- | ---- | ||
===== Авторизация. Login ===== | ===== Авторизация. Login ===== | ||
Строка 1279: | Строка 1278: | ||
//doc_date// – дата принятия заказа (формат dd.mm.yyyy), **не обязательный параметр**;\\ | //doc_date// – дата принятия заказа (формат dd.mm.yyyy), **не обязательный параметр**;\\ | ||
//fast_exec// – ID срочности, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_times;\\ | //fast_exec// – ID срочности, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_times;\\ | ||
+ | <ifauth @user> | ||
+ | "creater_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
+ | //creater_id// - ID приемщика заказа, **не обязательный параметр**. По умолчанию используется ID авторизованного пользователя;\\ | ||
+ | </ifauth> | ||
//sclad_id// – ID склада принятия, **обязательный параметр**;\\ | //sclad_id// – ID склада принятия, **обязательный параметр**;\\ | ||
//sclad_out_id// – ID склада выдачи, **обязательный параметр**;\\ | //sclad_out_id// – ID склада выдачи, **обязательный параметр**;\\ | ||
+ | <ifauth @user> | ||
+ | "current_sclad_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
+ | //current_sclad_id// - ID текущего склада заказа, **не обязательный параметр**. По умолчанию используется ID склада принятия заказа;\\ | ||
+ | </ifauth> | ||
//price_id// – ID прайс-листа, **не обязательный параметр**. По умолчанию 0 - "Розничный прайс лист";\\ | //price_id// – ID прайс-листа, **не обязательный параметр**. По умолчанию 0 - "Розничный прайс лист";\\ | ||
//date_out// – дата выдачи (формат dd.mm.yyyy HH:MM:SS), **не обязательный параметр**;\\ | //date_out// – дата выдачи (формат dd.mm.yyyy HH:MM:SS), **не обязательный параметр**;\\ | ||
Строка 1321: | Строка 1328: | ||
//dirty_id// – ID наценки, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_dirties;\\ | //dirty_id// – ID наценки, **не обязательный параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_dirties;\\ | ||
//status_id// – ID статус услуги, **не обязательный параметр**. Принимает значения 1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный; | //status_id// – ID статус услуги, **не обязательный параметр**. Принимает значения 1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный; | ||
+ | <ifauth @user> | ||
+ | "current_sclad_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
+ | //current_sclad_id// - ID текущего склада услуги, **не обязательный параметр**. По умолчанию используется ID склада принятия заказа;\\ | ||
+ | </ifauth> | ||
**addons** – массив объектов доп. реквизитов (**обязательный параметр**, если не реквизитов для заполнения, указывается пустым []):\\ | **addons** – массив объектов доп. реквизитов (**обязательный параметр**, если не реквизитов для заполнения, указывается пустым []):\\ | ||
Строка 1554: | Строка 1565: | ||
//sclad_id// – ID склада принятия, **не обязательный параметр**;\\ | //sclad_id// – ID склада принятия, **не обязательный параметр**;\\ | ||
//sclad_out_id// – ID склада выдачи, **не обязательный параметр**;\\ | //sclad_out_id// – ID склада выдачи, **не обязательный параметр**;\\ | ||
+ | <ifauth @user> | ||
+ | "current_sclad_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
+ | //current_sclad_id// - ID текущего склада заказа, **не обязательный параметр**. По умолчанию используется ID склада принятия заказа;\\ | ||
+ | </ifauth> | ||
//price_id// – ID прайс-листа, **не обязательный параметр**;\\ | //price_id// – ID прайс-листа, **не обязательный параметр**;\\ | ||
//date_out// – дата выдачи (формат dd.mm.yyyy HH:MM:SS), **не обязательный параметр**;\\ | //date_out// – дата выдачи (формат dd.mm.yyyy HH:MM:SS), **не обязательный параметр**;\\ | ||
Строка 1600: | Строка 1615: | ||
//dirty_id// – ID наценки, **не обязательный параметр параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_dirties;\\ | //dirty_id// – ID наценки, **не обязательный параметр параметр**. Берется из команды GetListsOrderTNDForAll, массив строк order_dirties;\\ | ||
//status_id// – ID статус услуги, **не обязательный параметр**. Принимает значение 1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный;\\ | //status_id// – ID статус услуги, **не обязательный параметр**. Принимает значение 1 – новый, 3 – в исполнении, 4 – исполненный, 5 – выданный, 7 - отмененный;\\ | ||
+ | <ifauth @user> | ||
+ | "current_sclad_id": "1234",<- перенести выше в пример в порядке следования описания, убрав отсюда\\ | ||
+ | //current_sclad_id// - ID текущего склада услуги, **не обязательный параметр**. По умолчанию используется ID склада принятия заказа;\\ | ||
+ | </ifauth> | ||
**addons** – массив объектов доп. реквизитов (**обязательный параметр**, если нет реквизитов на изменение, то оставляется пустым []):\\ | **addons** – массив объектов доп. реквизитов (**обязательный параметр**, если нет реквизитов на изменение, то оставляется пустым []):\\ | ||
Строка 2394: | Строка 2413: | ||
====== Работа с услугами====== | ====== Работа с услугами====== | ||
- | |||
- | ===== Получение фотографий услуг. GetOrderImagesForAll ===== | ||
- | |||
- | **Команда:** %%GetOrderImagesForAll%% | ||
- | |||
- | Команда просмотра фотографий заказа. | ||
- | |||
- | Метод отправки: **GET** | ||
- | |||
- | Заголовок запроса (Header): не требуется. | ||
- | |||
- | Формат запроса: %%GetOrderImagesForAll={"dor_id": "11223334"}&SessionID=%% | ||
- | |||
- | Строка запроса: <code>.../api/?GetOrderImagesForAll=%7B%22dor_id%22%3A%20%2211223334%22%7D&SessionID=…</code> | ||
- | |||
- | где\\ | ||
- | //dor_id// – ID заказа, **обязательно поле**. | ||
- | |||
- | Ответ **json**: | ||
- | <sxh json> | ||
- | { | ||
- | "error":0, | ||
- | "photos":[ | ||
- | { | ||
- | "dos_id": "100229859", | ||
- | "photo_id": "1004", | ||
- | "img": "R0lGODlhEgAMAOZaACtTezxtnyBEaI2t0lNzlVZ1lzZbgpSz1zJYgJOx1lJ+rS1VfT5ih0p4qIipz1Bwk1Fxkz9voYanzoKkyyxUfFRzlWOLt0BxokdpjTFYfy9WfpCv1GuSvXSZw0Jlik5ukUVojFV0lkRzpEFxonGXwUx6qVZ1lkNzo0l3p46t01qFsn6hyFmEsjhdhDZcgj9jiFSAro+u0zhqnSpSeoeozmKLtzNZgExtkD1unzhdg3GXwFN/rVZ0llN/rl+JtWSNuUlrjn+iykxtkS5WfZKx1jZcg5Kx1Xufx5Kw1TprnVaBr3mdxUh3pzxhhjlehUpsj2OMuFeCsD5iiDdcgylRejpfhSZPeDNmmZWz11d2l////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/wtYTVAgRGF0YVhNUDw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoV2luZG93cykiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6NjQyQjc1OThCRUJEMTFFNUFDRkVGNDdBMzUyNUUwMjQiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NjQyQjc1OTlCRUJEMTFFNUFDRkVGNDdBMzUyNUUwMjQiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDo2NDJCNzU5NkJFQkQxMUU1QUNGRUY0N0EzNTI1RTAyNCIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDo2NDJCNzU5N0JFQkQxMUU1QUNGRUY0N0EzNTI1RTAyNCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PgH//v38+/r5+Pf29fTz8vHw7+7t7Ovq6ejn5uXk4+Lh4N/e3dzb2tnY19bV1NPS0dDPzs3My8rJyMfGxcTDwsHAv769vLu6ubi3trW0s7KxsK+urayrqqmop6alpKOioaCfnp2cm5qZmJeWlZSTkpGQj46NjIuKiYiHhoWEg4KBgH9+fXx7enl4d3Z1dHNycXBvbm1sa2ppaGdmZWRjYmFgX15dXFtaWVhXVlVUU1JRUE9OTUxLSklIR0ZFRENCQUA/Pj08Ozo5ODc2NTQzMjEwLy4tLCsqKSgnJiUkIyIhIB8eHRwbGhkYFxYVFBMSERAPDg0MCwoJCAcGBQQDAgEAACH5BAXSAFoALAAAAAASAAwAAAd6gFZXg4SFhleCATpYjI2OjCQBgxIXUI+PPxcSg1gDKEpElwlRTANYnFhGMA0pjjElO0iMqIw1IzSMDic+B420WB09AStBOAodjqgHFhETR0kySxMRFr2nV1gbCg2mjwMNChvXDiIqCZeMCSwiDoMBHOiPHJKCh/aDVoEAIfkEBTwAWgAsAAAAABIADAAAB3eAAlaDhIWGVoIAIFmMjY6MIACDDwtSj48vCw+DWQQZOQWXBS0ZBFmcWSZTCBWOFTYuPIyojAyajBBDTY60WRhFADdCAAYYvFaNDBQfTzNUQB8UDI2cIQYIpo8ECAYhp1YQGlWhl1kFThoQgwAe5Y8ekoKH84MCgQA7" | ||
- | } | ||
- | ] | ||
- | } | ||
- | </sxh> | ||
- | |||
- | где\\ | ||
- | //photos// – массив фотографий;\\ | ||
- | //dos_id// – ID услуги заказа;\\ | ||
- | //photo_id// – ID фотографии;\\ | ||
- | //img// – фотография в строке base64. | ||
- | ---- | ||
===== Сохранение фотографии в услуге. SetOrderImagesForAll ===== | ===== Сохранение фотографии в услуге. SetOrderImagesForAll ===== | ||
Строка 3115: | Строка 3096: | ||
---- | ---- | ||
+ | ====== Устаревшие команды ====== | ||
+ | |||
+ | В данном разделе находятся уже устаревшие команды, но еще работающие. | ||
+ | |||
+ | Через несколько лет они будут удалены. | ||
+ | |||
+ | Для избежания поломки уже интегрированных устаревших команд, рекомендуется сделать переход на соответствующую актуальную команду. | ||
+ | |||
+ | ---- | ||
+ | ===== Получение фотографий услуг. GetOrderImagesForAll ===== | ||
+ | |||
+ | **Команда:** %%GetOrderImagesForAll%% | ||
+ | |||
+ | **Устаревшая команда**. Команда просмотра фотографий заказа.\\ | ||
+ | Для просмотра списка фотографий, рекомендуется использовать актуальную команду [[api#фотографии_по_заказу_orderimagesmodern|OrderImagesModern]]. | ||
+ | |||
+ | Для получения самой фотографии, используется команда [[api#фотографии_по_заказу_photoonline|PhotoOnline]]. | ||
+ | |||
+ | Метод отправки: **GET** | ||
+ | |||
+ | Заголовок запроса (Header): не требуется. | ||
+ | |||
+ | Формат запроса: %%GetOrderImagesForAll={"dor_id": "11223334"}&SessionID=%% | ||
+ | |||
+ | Строка запроса: <code>.../api/?GetOrderImagesForAll=%7B%22dor_id%22%3A%20%2211223334%22%7D&SessionID=…</code> | ||
+ | |||
+ | где\\ | ||
+ | //dor_id// – ID заказа, **обязательно поле**. | ||
+ | |||
+ | Ответ **json**: | ||
+ | <sxh json> | ||
+ | { | ||
+ | "error":0, | ||
+ | "photos":[ | ||
+ | { | ||
+ | "dos_id": "100229859", | ||
+ | "photo_id": "1004", | ||
+ | "img": "R0lGODlhEgAMAOZaACtTezxtnyBEaI2t0lNzlVZ1lzZbgpSz1zJYgJOx1lJ+rS1VfT5ih0p4qIipz1Bwk1Fxkz9voYanzoKkyyxUfFRzlWOLt0BxokdpjTFYfy9WfpCv1GuSvXSZw0Jlik5ukUVojFV0lkRzpEFxonGXwUx6qVZ1lkNzo0l3p46t01qFsn6hyFmEsjhdhDZcgj9jiFSAro+u0zhqnSpSeoeozmKLtzNZgExtkD1unzhdg3GXwFN/rVZ0llN/rl+JtWSNuUlrjn+iykxtkS5WfZKx1jZcg5Kx1Xufx5Kw1TprnVaBr3mdxUh3pzxhhjlehUpsj2OMuFeCsD5iiDdcgylRejpfhSZPeDNmmZWz11d2l////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/wtYTVAgRGF0YVhNUDw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoV2luZG93cykiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6NjQyQjc1OThCRUJEMTFFNUFDRkVGNDdBMzUyNUUwMjQiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NjQyQjc1OTlCRUJEMTFFNUFDRkVGNDdBMzUyNUUwMjQiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDo2NDJCNzU5NkJFQkQxMUU1QUNGRUY0N0EzNTI1RTAyNCIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDo2NDJCNzU5N0JFQkQxMUU1QUNGRUY0N0EzNTI1RTAyNCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PgH//v38+/r5+Pf29fTz8vHw7+7t7Ovq6ejn5uXk4+Lh4N/e3dzb2tnY19bV1NPS0dDPzs3My8rJyMfGxcTDwsHAv769vLu6ubi3trW0s7KxsK+urayrqqmop6alpKOioaCfnp2cm5qZmJeWlZSTkpGQj46NjIuKiYiHhoWEg4KBgH9+fXx7enl4d3Z1dHNycXBvbm1sa2ppaGdmZWRjYmFgX15dXFtaWVhXVlVUU1JRUE9OTUxLSklIR0ZFRENCQUA/Pj08Ozo5ODc2NTQzMjEwLy4tLCsqKSgnJiUkIyIhIB8eHRwbGhkYFxYVFBMSERAPDg0MCwoJCAcGBQQDAgEAACH5BAXSAFoALAAAAAASAAwAAAd6gFZXg4SFhleCATpYjI2OjCQBgxIXUI+PPxcSg1gDKEpElwlRTANYnFhGMA0pjjElO0iMqIw1IzSMDic+B420WB09AStBOAodjqgHFhETR0kySxMRFr2nV1gbCg2mjwMNChvXDiIqCZeMCSwiDoMBHOiPHJKCh/aDVoEAIfkEBTwAWgAsAAAAABIADAAAB3eAAlaDhIWGVoIAIFmMjY6MIACDDwtSj48vCw+DWQQZOQWXBS0ZBFmcWSZTCBWOFTYuPIyojAyajBBDTY60WRhFADdCAAYYvFaNDBQfTzNUQB8UDI2cIQYIpo8ECAYhp1YQGlWhl1kFThoQgwAe5Y8ekoKH84MCgQA7" | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | </sxh> | ||
+ | |||
+ | где\\ | ||
+ | //photos// – массив фотографий;\\ | ||
+ | //dos_id// – ID услуги заказа;\\ | ||
+ | //photo_id// – ID фотографии;\\ | ||
+ | //img// – фотография в строке base64. | ||
+ | ---- |