📂 Принцип обмена данными: Smart Data Hub обращается на URL указанных ниже методов API с определенным интервалом, получая в ответ актуальную на текущий момент времени информацию.
Полное описание методов CRUD API доступно по ссылке:
📚Документация к API Smart Data Hub
Для всех методов рекомендуется реализация пагинации через параметры limit\offset, с выводом в ответе полей count (количество элементов в текущем ответе) и total_count (всего элементов). Формат выходных данных – JSON, формат входных данных — JSON. Авторизация происходит через заголовок запроса:
Authorization: Token <токен_доступа>
Список опциональных операций. Их использование в проекте по желанию:
Также есть дополнительные методы: «Получение списка названий кастомных полей», «Получение списка наименований продуктов», «Получение списка наименований воронок продаж». Они обеспечивают получение словарей и текущих данных в API, подробнее см. Документация к API Smart Data Hub
На каждый заказ, зачастую, приходится ряд продуктов (товаров). Пример передачи ряда продуктов массивом приведен в описании основных методов:
Присвоение маркеров для статусов/состояний — является обязательным для обеспечение корректной работы интеграции.
Подробнее о маркерах и статусах см. ⚠️ 2. Создание статусов для воронки
Требования к полям:
Далее приведена последовательность действий для успешной настройки и запуска интеграции. Шаги делятся на Обязательные (⚠️) и Опциональные (❎)
Перейти далее к ⚠️ 0. Производим аутентификацию.