Сценарии использования API

API SO+ используется для односторонней выгрузки данных из сервиса SellOut+ в интегрируемую внешнюю систему.

Здесь под <API_URL> подразумевается URL вида: https://app.sellout.plus/<ВАШ_ТЕНАНТ>/api/

Описание

Выгрузка данных

Если необходима выгрузка всех данных с нуля, начните с п.1.

Если необходима выгрузка конкретного объекта, начните с п.2.

  1. Сначала загрузите Источники (data-source), т.к. во многих объектах данные разбиваются на блоки по ID источника.

    1. Отправьте запрос по URL, указав необходимый вам список полей, состоящий как минимум из поля ID:

      <API_URL>/sync/data-source?fields=ID

    2. Чтобы сравнить сходимость данных между SO+ и внешней системой, необходимо сравнить КС по объекту Источники (data-source). При расхождении — повторить синхронизацию объектов.

  2. Синхронизация остальных объектов.

    1. Определить название требуемого объекта в документации.

    2. Получить перечень всех блоков и контрольных сумм объекта:

      <API_URL>/checksum?object=<ИМЯ_ОБЪЕКТА>

    3. Выгрузить данные по каждому блоку объекта, указав необходимые для выгрузки во внешнюю систему поля объекта и поля для получения блока данных. Примеры запросов:

      1. <API_URL>/sync/<ИМЯ_ОБЪЕКТА>?fields=<НЕОБХОДИМЫЕ_ПОЛЯ>&ID_mapping_DataSource=<ID_ИСТОЧНИКА>&date=<ДАТА_ФАКТА>

      2. <API_URL>/sync/<ИМЯ_ОБЪЕКТА>?fields=<НЕОБХОДИМЫЕ_ПОЛЯ>&ID_mapping_DataSource=<ID_ИСТОЧНИКА>

      3. <API_URL>/sync/<ИМЯ_ОБЪЕКТА>?fields=<НЕОБХОДИМЫЕ_ПОЛЯ>

    4. Если важна согласованность данных между SO+ и внешней системой, то необходимо сравнить КС по объекту. При расхождении — повторить синхронизацию объектов.

    5. Если блок данных слишком большой или есть ограничение клиента на максимальное кол-во получаемых