Як підключити постачальника за API

Що вміє підключення за API

• Двадцять готових інтеграцій — постачальники України, Молдови, Казахстану, Словаччини та міжнародні.
• Розмітка заздалегідь — адреса сервера, формат і колонки підставляються самі.
• Параметри доступу — логін, пароль і IP-адреса для білого списку в одному вікні.
• Параметри запиту — мова каталогу, склад, обсяг прайсу, курс валют.
• Довідка постачальника — списки складів, категорій і брендів з ID.

Де це і хто має доступ

Меню

Довідники → Обробка прайс-листів → Список прайс-листів

Вибір інтеграції

майстер нового джерела, крок «Звідки» → плитка «API»

Параметри API

секція «Джерело» → «Налаштування параметрів API»

Право доступу

вікно «Список прайс-листів» плюс «Налаштування завантаження» і «…файл із прайс-листом»

Підготувати

логін і пароль (токен) від постачальника; іноді ID складу чи пункту видачі

Як пройти майстер нового джерела — у статті Як пройти майстер підключення джерела.

Які постачальники підключаються за API

Готова інтеграція за API — це модуль, який ми написали для конкретного постачальника. Файла тут немає взагалі: програма звертається до сервісу постачальника й отримує товари, ціни та наявність напряму. Від вас потрібні тільки логін і пароль.

Зараз таких інтеграцій двадцять, і вони доступні на кожному акаунті. Обирають їх тільки в майстрі, на кроці «Звідки»: плитка «API», під нею підзаголовок «Готові інтеграції за API» й пояснення — «Постачальники, чиє API ми підтримуємо самі — оберіть потрібного, далі вкажете параметри доступу.» У списку видно назву, країну й домен постачальника.

Порядок у таблиці — той самий, що на екрані: групи країн ідуть у порядку внутрішнього коду країни, а не за алфавітом її назви, тому найбільша група — українська — стоїть останньою. Назва країни показується мовою інтерфейсу, і кожна країна дає рівно одну групу.

1

Плитка «API»

2

Рядок постачальника в списку

3

Пояснення під заголовком

1. «API» — джерело запитує дані напряму в сервісу постачальника.
2. Кожен рядок списку — назва постачальника, країна і домен його API.
3. Готові інтеграції: обираєте постачальника — далі лишається вказати параметри доступу.

Для кількох інтеграцій є окремі статті:

• ERC — як завантажувати залишки тільки потрібного складу.
• Brain — повні картки товарів з описом і фото, відправка замовлень.
• DC Link — повні картки товарів і резерв з документа.
• Юг-Контракт — фото, повні картки товарів і замовлення з резервом.

Що програма робить, коли ви обираєте інтеграцію

Коли ви обираєте постачальника зі списку, програма робить за вас чотири речі:

• підставляє адресу сервера API;
• ставить правильний формат прайсу;
• створює перелік параметрів запиту;
• заздалегідь розмічає адреси колонок — артикул, назву, ціну, РРЦ, наявність, категорію.

Саме тому в майстрі для API немає третього кроку: зіставленняЗвʼязок між тим, що надіслав постачальник, і тим, що є у вас: категорія прайсу з вашою категорією, товар прайсу з вашим товаром, колонка файлу з полем системи. Роблять один раз — далі програма застосовує його при кожному завантаженні. колонок уже зроблено, перевіряти нема чого. Замість таблиці колонок майстер одразу відкриває вікно параметрів доступу.

Як вписати доступи й IP для білого списку

Вікно називається «Налаштування параметрів доступу до API», у заголовку — назва інтеграції та домен постачальника. Відкрити його пізніше можна кнопкою «Налаштування параметрів API» у секції «Джерело». Усередині три картки.

«Доступ» — «Посилання на сервер API», «Логін» і «Пароль (токен)». Адреса вже підставлена, від вас потрібні тільки облікові дані, які видав постачальник. Зберігається все автоматично.

Під полями стоїть рядок «IP-адреса сервера Elbuz Jumper, яку необхідно передати постачальнику для надання доступу:» і сама адреса IPv4. Якщо постачальник просить ваш IP для білого списку свого API — беріть її саме звідси: запити до API йдуть із сервера Elbuz, а не з вашого компʼютера чи офісу, тому адреса вашого провайдера постачальнику не підійде.

«Параметри запиту» — що і як запитувати: мова каталогу, склад, фільтри. Таблиця з колонками «Параметр», «Значення» й «Опис»; правка значення зберігається одразу. Якщо у постачальника додаткових параметрів немає, там буде написано «У цього API немає додаткових параметрів запиту.»

«Довідка постачальника» — кнопка «Отримати довідкові дані». Вона запитує в постачальника списки складів, категорій і брендів разом з їхніми ID, щоб ці ID можна було підставити в параметри запиту.

У шапці вікна є кнопка «Завантажити»: вона зберігає доступи й запускає імпорт. Запускає не в собі, а у вікні списку джерел — тож якщо ви його закрили, побачите «Відкрийте вікно «Прайс-листи постачальників» і запустіть завантаження джерела.»

Як налаштувати параметри запиту

Параметри в кожного постачальника свої. Кілька прикладів, щоб було зрозуміло, про що йдеться:

1

Колонка «Параметр»

2

Колонка «Значення»

3

Кнопка «Отримати довідкові дані»

1. «Параметр» — назва налаштування запиту (мова, склад, фільтри).
2. «Значення» — те, що підставляється в запит до постачальника; змінюється і зберігається одразу.
3. Кнопка завантажує довідкові списки складів, категорій і брендів постачальника з їхніми ID.

Прайс за API завантажився, а характеристик і фото немає. У ERC характеристики, опис і додаткові фото приходять другим запитом — за посиланням із параметра «Посилання на API для завантаження атрибутів і фото».

Якщо токен у цьому посиланні неправильний або застарів, завантаження не зупиняється: ціни й наявність приходять, а характеристики та фото пропускаються. У журналі джерела зʼявляється рядок «Помилка API постачальника: характеристики та фото не завантажено (перевірте токен у «Посилання на API для завантаження атрибутів і фото»)» з відповіддю сервісу після двокрапки. Попросіть у постачальника новий токен і вставте посилання з ним у цей параметр; як скласти посилання — у статті про ERC.

Якщо така правка вже пройшла, зайві позиції прибирає наступний імпорт — порядок дій у розділі «Якщо спосіб налаштували з помилкою».

Де взяти ID складу чи пункту видачі

Кнопка «Отримати довідкові дані» працює не в усіх інтеграцій: із двадцяти активних довідника не мають девʼять — ERC, DC Link, Юг-Контракт, BigBuy, Antey, vidaXL, artline.ua, dmlink.md і PHOENIX. Вікно так і пише: «У цієї інтеграції немає довідкових даних: постачальник не віддає списки складів, категорій та інших значень для параметрів запиту. Заповніть параметри вручну за документацією постачальника.» ID складу чи пункту видачі в такому разі запитують у самого постачальника.

Частина інтеграцій віддає більше, ніж прайс: категорії постачальника, характеристики товарів або фотографії — вони приїжджають окремими файлами поруч із прайсом. А ERC і DC Link при увімкненому параметрі «Завантажувати курс валют» передають ще й свій курс, який підставляється в ціни.

У журналі прогону робота за API видно рядками «Підключення до API сервера» і «Отримано файл: ‹розмір› МБ». Якщо постачальник відмовив, у журнал потрапить «Помилка API постачальника: ‹причина›» — після двокрапки стоїть дослівна відповідь постачальника, і читати треба саме її.

Сценарії

Потрібна наявність тільки свого пункту видачі BRAIN

Що зробити. У майстрі нового джерела на кроці «Звідки» — плитка «API», у списку «Готові інтеграції за API» — BRAIN. У вікні «Налаштування параметрів доступу до API» впишіть «Логін» і «Пароль (токен)», натисніть «Отримати довідкові дані» й знайдіть свій пункт у списку пунктів видачі. Його ID впишіть у «Пункт видачі (ID)», «Обсяг прайсу» лишіть 0.

Що вийде. Прайс приходить зі складу обраного пункту видачі. Колонки вже розмічені, окремого кроку зіставлення колонок немає.

Чого не буде. Без ID пункту видачі прайс не запитується зовсім. «Обсяг прайсу» 1 не фільтрує «лише в наявності», а віддає весь каталог постачальника. Помилитися з інтеграцією можна лише раз: перемкнути джерело на іншу не вийде, тільки створити нове. Решта налаштувань Brain — у статті про інтеграцію з Brain.

У майстрі обрали не того постачальника

Що зробити. Створіть нове джерело й у майстрі на кроці «Звідки» оберіть правильну інтеграцію. Помилкове джерело вимкніть або видаліть.

Що вийде. Нове джерело отримує адресу сервера, формат і розмітку колонок правильного постачальника.

Чого не буде. Перемкнути наявне джерело на іншу інтеграцію в інтерфейсі не можна.

Що робити, коли прайс за API не приходить

Часті запитання

Чи можна перемкнути джерело на іншу інтеграцію за API?

Ні. Привʼязка інтеграції записується один раз, і в інтерфейсі її не змінити. Якщо обрали не того постачальника, створіть нове джерело й оберіть правильну інтеграцію в майстрі.

Потрібного постачальника немає серед готових інтеграцій. Що робити?

Домовлятися про файл: пряме посилання, лист із вкладенням або доступ до FTP. Ці способи працюють з будь-яким постачальником — способи отримувати прайс.

Постачальник просить наш IP для доступу до API. Де його взяти?

У вікні «Налаштування параметрів доступу до API», картка «Доступ», рядок «IP-адреса сервера Elbuz Jumper…». IP свого компʼютера чи офісу не вказуйте: до API звертається сервер Elbuz.

Прайс ERC вантажиться без характеристик і фото. Що робити?

Перевірити токен у параметрі «Посилання на API для завантаження атрибутів і фото». Якщо він застарів, ціни приходять, а характеристики й фото пропускаються. Попросіть новий токен — про ERC.

Кнопка «Отримати довідкові дані» нічого не дає. Чому?

У девʼяти інтеграцій довідника немає: постачальник не віддає списки складів і категорій. ID складу чи пункту видачі тоді запитують у постачальника — про довідку.

Суміжні теми

• Якщо потрібна загальна картина: як обрати спосіб і що буде, коли файл не приїхав — Способи отримувати прайс від постачальника.
• Якщо підключаєте Brain — інтеграція з Brain.
• Якщо підключаєте ERC — інтеграція з ERC.
• Якщо постачальника немає серед інтеграцій, а прайс він шле листом — Як отримувати прайс постачальника з листа.