Документация

Инструменты пользователя

Инструменты сайта

Вы посетили: • rsform • sync_api

Боковая панель

sync_api

Это старая версия документа!

Содержание

sync API

Данный API реализует постановку в очередь файлов накопительной загрузки, а также обратную связь для получения необходимого среза данных.

Порядок постановки в очередь

Данный порядок необходим для предотвращения возможных ошибок при загрузке данных, и рисков, связанных с ними.

  1. Запросить дату актуальности последней синхронизации запросом к syncInfo
  2. Сформировать xml с даты последней синхронизации по текущую
  3. Загрузить xml файл. Имя файла должно быть уникальным. Заменять уже загруженные файлы запрещено.
  4. Поставить xml файл в очередь на синхронизацию запросом к syncAdd

Загрузка данных на портал

Параметры передаются в виде POST или GET запроса.

SyncInfo

имя сайта/?option=com_wmartalpha&task=system.syncInfo

Получает информацию о текущей очереди. Результат возвращается в формате JSON.

Запрос

АргументОписаниеТипПо-умолчанию
typeТип синхронизируемого файла. Например: catalog, storage string обязательный
realmИмя базы данных (используется при независимых базах данных)string

Ответ

АргументОписаниеТипПо-умолчанию
codeКод ответаКод ответа
statusТекстовое описание результата запросаstring
queueДлина текущей очередиint
date_lastДата последней синхронизации сервераdatetime dd.mm.YYYY HH:mm:ss
Пример

https://sitename.ru?option=com_wmartalpha&task=system.syncInfo&type=catalog

SyncAdd

имя сайта/?option=com_wmartalpha&task=system.syncAdd

Добавляет файл в очередь синхронизации. Результат возвращается в формате JSON.

Запрос

АргументОписаниеТипПо-умолчанию
typeТип синхронизируемого файла. Например: catalog, storage string обязательный
date_startДата последней синхронизацииdatetime dd.mm.YYYY HH:mm:ss обязательный
date_endДата текущей синхронизации (обычно дата формирования файла)datetime dd.mm.YYYY HH:mm:ss обязательный
filenameимя XML файлаstring обязательный
realmИмя базы данных (используется при независимых базах данных)string

Ответ

АргументОписаниеТипПо-умолчанию
codeКод ответаКод ответа
statusТекстовое описание результата запросаstring
queueДлина текущей очередиint
date_lastДата последней синхронизации сервераdatetime dd.mm.YYYY HH:mm:ss
Пример

https://sitename.ru?option=com_wmartalpha&task=system.syncAdd&type=catalog&filename=_Items678246.xml&date_start=23.07.2019%2022:58&date_end=24.07.2019%2022:58

Коды ответов

Любой отличный от 1 код ответа следует рассматривать как ошибку запроса.

Код ответаРасшифровка
1Запрос успешно исполнен
20Тип файла указан некорректно
30Файл отсутствует в папке заливки
31Не удалось разобрать XML файл. Файл имеет некорректную структуру или был поврежден при загрузке
40Дата текущей синхронизации указана некорректно
41Дата последней синхронизации сервера не совпадает с датой последней синхронизации файла

Выгрузка данных на портал

Параметры передаются в виде POST или GET запроса.

orderItems

имя сайта/?option=com_wmartalpha&task=system.orderItems

Получает xml документ с данными заказов измененных начиная с времени date_change

Запрос

АргументОписаниеТипПо-умолчанию
date_changeВремя изменения заказаdatetime dd.mm.YYYY HH:mm:ss00.00.0000 00:00:00
Пример

https://sitename.ru?option=com_wmartalpha&task=system.orderItems&date_change=01.01.2020%2023:00

sync_api.1611961959.txt.gz · Последние изменения: 2021/01/30 02:12 — a1

Инструменты страницы

Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki