external:procart:02_procart_api:01_api

Различия

Показаны различия между двумя версиями страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия		 Предыдущая версия
external:procart:02_procart_api:01_api [2022/10/01 12:49] – [Типовая схема запросов] Александр Ильинexternal:procart:02_procart_api:01_api [2024/06/10 09:44] (текущий) – [Перечень методов API ProCart] Данил Володченко
Строка 1: Строка 1:
 ====== Описание API ====== ====== Описание API ======
-===== Перечень запросов API ProCart =====+===== Перечень методов API ProCart =====
  
   * **/ping** - служебный метод для проверки связи, состояния лицензии, валидности токена.   * **/ping** - служебный метод для проверки связи, состояния лицензии, валидности токена.
   * **/getmenu** - метод для получения меню (классификация, блюда и их свойства, остатки, схемы модификаторов и комбо).   * **/getmenu** - метод для получения меню (классификация, блюда и их свойства, остатки, схемы модификаторов и комбо).
   * **/validate** - метод для проверки возможности создания заказа (заказ НЕ создается).   * **/validate** - метод для проверки возможности создания заказа (заказ НЕ создается).
-  * **/postorder** - метод для создания заказа.+  * **/postorder** - метод для создания заказа в кассовой системе.
   * **/getorders** - метод для получения информации о заказах.   * **/getorders** - метод для получения информации о заказах.
-  * **/print_info** - служебный метод для получения длинных комментариев (используется в макетах печатных форм r_keeper).+  * **/close** - метод для закрытия заказа. 
 +  * **/internal/print_info** - служебный метод для получения длинных комментариев (используется в макетах печатных форм r_keeper).
  
-===== Типовая схема запросов =====+Документация к API - [[http://95.64.142.2:1112/swagger#|ссылка]] 
 +Токен API: 28bb0d65-d1a3-447d-a3eb-e4961b0ffd35 
 + 
 +Все запросы отправляются в "ip:port/api/v3" 
 +Например [[http://127.0.0.1:11111/api/v3/ping|127.0.0.1:11111/api/v3/ping]] 
 + 
 +**Важно!** Все методы возвращают ответы в кодировке UTF-8 
 +===== Некоторые особенности использования методов API =====
 Метод **/ping** не является обязательным и не приводит ни к каким действиям на стороне кассовой системы, но в то же время он очень полезен. С его помощью можно:  Метод **/ping** не является обязательным и не приводит ни к каким действиям на стороне кассовой системы, но в то же время он очень полезен. С его помощью можно: 
   * Проверить доступность ProCart   * Проверить доступность ProCart
Строка 34: Строка 42:
 **Важно!** Если логика внешней системы подразумевает оплату заказа, то перед тем как вызвать метод **/postorder** необходимо провести оплату заказа (а сумму к оплате взять из ответа на запрос **/validate**). И только после успешной оплаты создавать заказ методом **/postorder**, не забыв при этом передать данные об оплате. **Важно!** Если логика внешней системы подразумевает оплату заказа, то перед тем как вызвать метод **/postorder** необходимо провести оплату заказа (а сумму к оплате взять из ответа на запрос **/validate**). И только после успешной оплаты создавать заказ методом **/postorder**, не забыв при этом передать данные об оплате.
  
----- +===== Типовая схема запросов =====
 В итоге, для того что бы создать заказ на кассе, внешняя система должны последовательно выполнить запросы: В итоге, для того что бы создать заказ на кассе, внешняя система должны последовательно выполнить запросы:
   - Убедиться в доступности шлюза ProCart (**/ping**).   - Убедиться в доступности шлюза ProCart (**/ping**).
Строка 41: Строка 48:
   - Убедиться в возможности создания заказа с нужным перечнем блюд в текущий момент времени (**/validate**).   - Убедиться в возможности создания заказа с нужным перечнем блюд в текущий момент времени (**/validate**).
   - Создать заказ (**/postorder**).   - Создать заказ (**/postorder**).
-  - При необходимости отслеживать изменения статуса заказа (**/getorders**).+  - При необходимости отслеживать дальнейшие изменения статуса заказа (**/getorders**). 
 + 
 +---- 
 +**Важно!**  
 +При создании заказа, через **callback_url** возможно указать адрес, куда будет отправляться состояние заказа при изменении его статуса. 
 + 
 +Заказ может иметь статус: 
 +  * deferred - заказа создан в кассовой системе как черновик 
 +  * open - заказ создан в кассовой системе и с ним ведётся работа 
 +  * bill - в заказе выбит пречек 
 +  * close - закрыт выполнен рассчёт по заказу и выбит чек 
 +  * deleted - заказ удалён в кассовой системе
  
  
  
  
  • external/procart/02_procart_api/01_api.1664617775.txt.gz
  • Последнее изменение: 2022/10/01 12:49
  • — Александр Ильин