Общие сведения

Облачный сервис st-mobi.com позволяет интегрироваться с любой учетной системой (УС), благодаря единому протоколу обмена.
Обмен между УС и облачным сервисом происходит посредством XML файлов с использованием FTP-сервера.
С полным описанием протокола обмена, перечнем сущностей и фрагментами XML файлов, можно ознакомиться в разделе "Протокол Обмена Данными".

В данной статье будут описаны требования возлагаемые на интеграцию клиента при работе с FTP-сервером. 

Как получить доступ к FTP

Доступ на FTP-сервер будет доступен после регистрации и установки флага обмена с УС в настройках сервиса.

Как подключиться

В целях ознакомления со структурой каталогов FTP-сервера, можно использовать любой FTP-клиент (например, FileZilla).

Структура каталогов

Примечание

При первом подключении к FTP-серверу, каталоги отсутствуют, их необходимо создать.

Через некоторое время (по-умолчанию -10 минут) после активации обмена с УС, сервис автоматически создаст ряд каталогов и разместит файлы обмена (пустые):

  • out - содержит текущие файлы выгрузки, сформированные сервисом
  • out_archive - хранилище файлов выгрузки за последние три дня

Каталоги, которые необходимо создать самостоятельно (вручную или программно через интеграцию):

  • tmp - каталог для временного хранения импортируемых файлов из УС
  • in - рабочий каталог, содержит перечень импортируемых файлов

Остальные каталоги сервис создаст автоматически по мере необходимости.

Взаимодействие с FTP-сервером

Взаимодействие делится на два вида:

  • выгрузка 
  • загрузка

Выгрузка

Сформированные и упакованные в ZIP архив XML файлы необходимо отправить в каталог хранения временных файлов FTP-сервера "tmp", затем переместить в каталог "in".
Данное действие необходимо осуществлять во избежании ошибок при импорте XML файлов в сервис.

После того, как файл будет перемещен в каталог "in", система импорта начнет его обработку, либо поставит в очередь, если имеются ещё файлы на импорт.
При успешном импорте, XML файл будет перемещен в каталог "archive" (будет создан, если отсутствует), в противном случае сформируется файл ошибки с расширением ".log" и вместе с импортируемым файлом будет перемещен в каталог "errors".
В случае ошибки импорта, в интерфейсной части сервиса, также отобразится уведомление.

Загрузка

Сервис формирует XML файлы, содержащие определенные на этапе интеграции данные.
Интервал формирования определяется в настройках сервиса, в разделе "Обмен с УС", минимальный интервал - 10 минут.
Файлы упакованы в ZIP архивы, поэтому, перед обработкой в УС, необходимо предусмотреть извлечение.

Как упоминалось ранее, сервис размещает файлы в каталоге "out". откуда и необходимо скачивать файлы.
После скачивания, файлы необходимо удалить, поскольку максимальное количество фалов в каталоге "out" не может превышать 10.
В случае превышения, сервис приостановит формирование новых файлов.

  • Нет меток