Техническое задание

Типовое техническое задание для интеграции веб-сайта с сервисом "REGOS"


Общее

Используйте тестовый доступ для создания и тестирования вашей интеграции.

При завершении тестирования и перехода в боевой режим работы получите ключ разработчика АррКеу (как получить?).

Интеграция веб-сайта с сервисом REGOS делится на подзадачи:

  1. Периодическая синхронизация справочных данных(номенклатура. цены, остатки);
  2. Запрос текущего количества номенклатуры при его добавлении в корзину и осуществлении заказа;
  3. Отправка заказа в сервис REGOS;
  4. Использование веб-хука для получение информации об изменении статуса заказа.

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


1. Периодическая синхронизация справочных данных

Для передачи данных из базы REGOS в базу веб-сайта необходимо использовать выгрузку на веб-сервер.

Если вам недостаточно данных, или вам нужна иная логика интеграции, вы можете использовать метод получения списка номенклатуры Item/Get или его расширенный аналог (с наличием цен, текущего кол-ва, ссылки на изображение) Item/GetExt.

Внимание! Если вы используете изображения, для отображения номенклатуры на вашем сайте, мы рекомендуем вам скачивать изображения с сервиса REGOS на ваш веб-сервер и настроить кэширование для ускорения работы вашего сайта и улучшения пользовательского опыта.


2. Запрос текущего количества товара при его добавлении в корзину и осуществлении заказа

При добавлении номенклатуры в корзину (на сайте), а также до подтверждения заказа и передачи его в REGOS рекомендуется проверить текущий остаток в системе Regos и необходимое количество добавления в корзину.
Для этого можно использовать метод GetQuantity. Либо можно получить полную информацию о товаре (товарах) с помощью метода Item/GetExt.


3. Отправка заказа в систему REGOS

Для создание документа розничного заказа с его содержимым необходимо использовать метод DocOrderDelivery/AddFull.


4. Использование веб-хука для получение информации об изменении статуса заказа

Чтобы получить информацию об изменении статуса заказа настройте и используйте веб-хук DocOrderDeliveryStatusChanqed.