Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия | |||
|
doc:dev:api:item [22.10.2025 12:06] rlysov [Пример запроса на массовое добавление/изменение данных] |
doc:dev:api:item [20.04.2026 21:32] (текущий) rlysov |
||
|---|---|---|---|
| Строка 230: | Строка 230: | ||
| </problem_external_ids> | </problem_external_ids> | ||
| </root> | </root> | ||
| + | </file> | ||
| + | |||
| + | ===== Загрузка изображений для товаров ===== | ||
| + | |||
| + | Эндпоинт позволяет загрузить изображения для одного или нескольких товаров по внешним ссылкам. Изображения скачиваются с указанных URL и добавляются к товарам. | ||
| + | |||
| + | Пример запроса: | ||
| + | |||
| + | https://[company].myvirtualpos.ru/api/item/importImages?apikey=MySecret | ||
| + | |||
| + | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| + | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| + | |||
| + | * **items** - JSON-массив объектов, каждый из которых описывает товар и список ссылок на изображения. Обязательный параметр. Каждый объект должен содержать: | ||
| + | * **id** - код товара (целое число). Обязательный. | ||
| + | * **urls** - массив ссылок на изображения. Обязательный, не может быть пустым. | ||
| + | |||
| + | * **rewrite_all** - опционально. Если истина ("1" или "true"), существующие изображения товара будут удалены перед добавлением новых. Если ложь (по умолчанию), новые изображения добавляются к уже существующим. | ||
| + | |||
| + | ==== Пример запроса ==== | ||
| + | |||
| + | <file http> | ||
| + | POST /api/item/importImages?apikey=11112222 HTTP/1.1 | ||
| + | HOST: company.myvirtualpos.ru | ||
| + | content-type: application/x-www-form-urlencoded | ||
| + | |||
| + | items=[{"id":1,"urls":["https://example.com/img1.jpg","https://example.com/img2.jpg"]},{"id":2,"urls":["https://example.com/img3.jpg"]}]&rewrite_all=1 | ||
| + | </file> | ||
| + | |||
| + | ==== Ответ сервера ==== | ||
| + | |||
| + | В ответ получаем JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info. | ||
| + | |||
| + | Операция считается успешной, если данные были корректно переданы и обработаны. Если отдельные изображения не удалось скачать (недоступный URL, неверный тип файла) или товар с указанным id не найден, то в поле info будут перечислены соответствующие сообщения об ошибках. | ||
| + | |||
| + | ==== Пример успешного ответа ==== | ||
| + | |||
| + | <file json> | ||
| + | {"success":1} | ||
| + | </file> | ||
| + | |||
| + | ==== Пример ответа с ошибками ==== | ||
| + | |||
| + | <file json> | ||
| + | {"success":0,"info":"Товар не найден: 999; Не удалось скачать файл: https://example.com/missing.jpg"} | ||
| </file> | </file> | ||