Огляд API імпорту
У цьому розділі описано основні аспекти роботи з API імпорту: аутентифікацію, рекомендовані підходи до передачі даних і забезпечення ідемпотентності запитів.
Аутентифікація
Усі запити до API повинні містити заголовок X-Secret-Token із вашим секретним токеном інтеграції.
X-Secret-Token: ваш-секретний-токен
warning
Ваш секретний токен надає повний доступ до управління вашими товарами в Spefix. Ніколи не публікуйте його у відкритому доступі, не зберігайте у клієнтському коді (frontend) та передавайте виключно через захищені серверні запити.
Найкращі практики
Рекомендовані підходи допомагають оптимізувати продуктивність інтеграції та гарантувати коректну обробку даних:
- Пакетні Операції: Надсилайте дані блоками по 100–500 записів за запит. Це мінімізує затримки та навантаження на сервер.
- Обробка Помилок: У відповідях з частковим успіхом перевіряйте поле
errorsдля кожного елемента. Лише після обробки всіх помилок можна вважати запит успішним. - Спочатку Категорії: Завжди спочатку створюйте або оновлюйте категорії
source_category_id, а вже потім — товари. Це запобігає помилкам, пов’язаним з невизначеною категорією. - Зняття з Публікації: Для приховування або видалення товарів використовуйте спеціальний ендпоінт видимості (visibility). Так ви не втратите історію змін і збережете цілісність даних.
- Ідемпотентність: Запити на створення або оновлення ідентифікуються за полями
source_id(для товарів) іsource_category_id(для категорій). Повторна передача того самого ідентифікатора обробляється в останній версії даних.
tip
Застосування цих рекомендацій гарантує стабільність інтеграції, підвищує швидкість обробки та спрощує діагностику помилок.