Различия

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

--- api [2020/02/27 04:45] – timofeev
+++ api [2024/09/13 06:26] (текущий) – timofeev
@@ Строка 1: / Строка 1: @@
 ====== API Водяного ======
-<code>ip-адрес Водяного:10400/api?token=секретный ключ&action=команда&param={...}</code>
+<code>ip-адрес Водяного:10400/api?token=секретный_ключ&action=команда&param={...}</code>
 Здесь команда — команда API;\\
 параметры команды задаются в формате json (имя_параметра:значение параметра разделенные точкой с запятой).\\
 token — ключ доступа, задается в поле "пароль" [[параметры_интеграции|справочника интеграций]], например  qwerty12345\\
+Токен может быть указан как в url запроса, так и в заголовке 'Authorization: Bearer секретный_ключ'.\\
+Примечание: Для работы с API должен быть "проброшен" во внешнюю сеть порт 10400 сервера, где установлена база данных и установлен на этом сервере Водяной в режиме службы.\\
 Все ответы передаются в кодировке UTF-8, запросы ожидаются в той же кодировке.\\
-Ниже приведены описания возможных команд
+Ниже приведены описания команд:
-[[API_zagr_tov|Загрузка списка товаров во внешнюю систему (zagr_tov)]]
+[[API_spistov|Загрузка списка товаров во внешнюю систему (spistov)]]
 [[API_zakaz|Формирование предварительной заявки (zakaz)]]
+[[API_platkart|Платеж картой]]
+[[API_statusz|Получение статуса заказа (statusz)]]
+[[API_otmenaz|Отмена заказа (otmenaz)]]
+[[API_posledz|Последние заказы (posledz)]]
+[[API_dolg|Получение данных о долге (предоплате)]]
+[[API_spr|Чтение справочников]]
+[[API_doc|Чтение документов]]
+Кроме описанной версии API, доступен [[rest|REST-вариант]].
-=== Получение статуса заказа  (GET) ===
-<code>ip-адрес Водяного:10400/api?token=секретный ключ&action=statusz&param={...}</code>
-параметры: id – номер заказа, под которым он был создан во внешней системе (на сайте) и отправлен в программу\\
-ответ: состояние заказа в виде числа\\
-возможные варианты:\\
-— заказ отсутствует в системе\\
-— записан (пришел с сайта)\\
-- принят (обработан оператором, создана расходная накладная), но еще не назначен экспедитору/водителю\\
-— отправлен экспедитору, но еще не дошел до него, такой статус в нормальной ситуации (при использовании мобильного приложения) может сохраняться не более минуты\\
-- у экспедитора (пришел на планшет, телефон)\\
-— выполнен\\
-- не удалось выполнить\\
-- отменен клиентом\\
-Пример: <code>4.4.4.4:10400/api?token=aaabbb123456&action=statusz&param={”id”:”12356”}</code>\\
-Ответ: 3\\
-(заказ получен экспедитором, выполняется).\\