-
-
-
- Примеры
- API
Инструменты пользователя
Боковая панель
sync_api
Это старая версия документа!
Содержание
sync API
Данный API реализует постановку в очередь файлов накопительной загрузки, а также обратную связь для получения необходимого среза данных.
Отправка данных на портал
Параметры передаются в виде 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 |
Пример
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 |
Пример
Коды ответов
Любой отличный от 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:ss | 00.00.0000 00:00:00 |
Пример
sync_api.1611962046.txt.gz · Последние изменения: 2021/01/30 02:14 — a1
Инструменты страницы
Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International
