SvitStyle API дозволяє керувати Вашими товарами на нашому сайті з адмінки власного сайту.
За допомогою цього API Ви зможете
-отримати список товарів на SvitStyle
-додавати нові товари
-оновлювати існуючі товари
-видаляти товари.
Інтегрувавши API в своє програмне забезпечення, всі зміни, які Ви робите зі своїми товарами на власному сайті, будуть синхронно відображатися і на SvitStyle. Завдяки цьому, інформація про Ваші товари буде оновлюватися миттєво і буде завжди актуальною.
Для інтеграції API вам необхідно буде залучити програміста (процес займе 8-10 робочих годин).
Принцип використання API
Виклик методу відбувається через HTTP запит по URL типу:
http://www.svitstyle.com.ua/api.php?api_key=KEY&method=METHOD¶m1=PARAM1....
Вхідні параметри приймаються як в GET, так і POST запитах (GET - пріоритет), всі параметри слід надсилати в кодуванні UTF-8
Приклад використання на PHP
Вхідні параметри
для всіх методів
- api_key - ключ доступу до API (обов'язковий), отримати ключ можна в Кабінеті / Мій магазин
- method - назва методу (обов'язковий)
- response - тип виводу json, xml (не обов'язковий, по-замовчуванню json)
- lang - мова ua - укр, ru - рос (не обов'язковий)
для методів з підтримкою сторінок
- perpage - кількість на сторінку (по-замовчуванню 20)
- page - номер сторінки (по-замовчуванню 1)
Вихідні дані
для всіх методів
- ts - timestamp
- result :success/error - успішно/помилка
- errors - список помилок {
code - код помилки
message - повідомлення
}
для методів з посторінковим виводом та кількістю сторінок більше одної
- pageTab: {
count - кількість записів
perpage - кількість на сторінку (по-замовчуванню 20, максимум-500)
page - номер сторінки
pages_count - кількість сторінок
}
Приклад відповіді
успішно:
{"list":{...},"exect_time":0.00062,"ts":1455180611,"response":"success"}
помилка:
{"ts":1455180725,"response":"error","errors":[{"code":"102","message":"required parameter: method"}]}
Список методів
getCountryList - отримати список країн
вихідні дані
list{
- id - ID країни
- name - назва країни
}
getBrandList - отримати список брендів
вихідні дані
list{
- id - ID бренду
- name - назва бренду
}
getColorList - отримати список кольорів
вихідні дані
list{
- id - ID кольору
- name - назва кольору
}
getCategoryList - отримати список категорій
вихідні дані
list{
- id - ID категорії
- name - назва категорії
- parent_id - ID батьківської категорії
}
getProductList - отримати список товарів
вихідні дані
list{
- id - ID товару
- enable - 1:включений; 0:відключений
- category_id - ID категорії
- code - код товару
- price - ціна, грн
- price_special - ціна зі знижкою
- country_id - ID країни
- brand_id - ID бренду
- brand_type - тип бренду 1:оригінал; 2:копія
- outside_url - * зовнішній url
- url_key - * md5 від outside_url в нижньому регістрі
- name_ua - * назва товару українською
- name_ru - * назва товару російською
- description_ua - * опис товару українською
- description_ru - * опис товару російською
- picture - * зображення товару
- color_id - * колір зображення товару
- date_added - * дата додавання товару
- date_last_modified - * дата останньої зміни товару
- size - * список розмірів товару
- color - * список кольорів товару
{
- id - id кольору
- name - назва кольору
}
- option - *список опцій
{
- option_name - назва опції
- option_value - значення опції
}
- gallery - * список додаткових зображень
{
- picture - додаткове зображення
- color_id - колір додаткового зображення
}
- size_standart - * стантарт розміру (якщо виводяться розміри)
}
вхідні параметри (не обов'язкові)
show_fields - перелік додаткових полів (позначених *) через кому для виводу
Фільтрування для
getProductList можливе по всіх полях крім: size, color, option, gallery наприклад:
enable=1 - тільки включені
code=~123 - поле code містить 123
startUpdateProductList - початок пакетного поновлення товарів. Метод використовується для початку відмічення товарів, що поновлюються для подальшого відключення непоновлених товарів
вихідні дані
- product_selected - кількість відмічених для обробки товарів
- product_cn - кількість товарів
{
- enable - включених
- disable - відключених
}
endUpdateProductList - кінець пакетного поновлення товарів - відключення непоновлених товарів
вихідні дані
- product_disabled - кількість відключених товарів після поновлення
- product_cn - кількість товарів
{
- enable - включених
- disable - відключених
}
updateProductList - оновлення або додавання товарів.
Пошук ведеться по outside_url або id якщо товар знайдено, то поновлення відбувається по полях, що є в списку
вихідні дані
- total - кількість оброблених записів
- insert - кількість доданих товарів
- update - кількість поновлених товарів
вхідні параметри
Обробляється масив (не більше 20 за раз) аналогічний по структурі до методу
getProductList
додаткові параметри
update_param{
- not_insert - не додавати нових (поновлювати тільки іcнуючі )
- only_price = 1 - поновлювати тільки ціну (по замовчуванню 0)
- name = 1 - поновлювати назву (по замовчуванню 0)
- description = 1 - поновлювати опис (по замовчуванню 0)
- translate - перекладати name та description, ua - на українську; ru - на російську (по замовчуванню - не перекладати)
- gallery = 1 - поновлювати галерею, видалити старі значення (по замовчуванню 0)
- option = 1 - поновлювати атрибути, видалити старі значення (по замовчуванню 0)
- size = 1 - поновлювати розміри, видалити старі значення (позамовчуванню 0)
}
Якщо товар не знайдено, то він буде доданий
обовязкові поля
- category_id - ID категорії
- price - ціна, грн
- country_id - ID країни, або назва
- brand_id - ID бренду, або назва
- brand_type - 1 - оригінал; 2-копія
- outside_url - зовнішній url
- picture - зображення товару
- name або name_ua і/або name_ru - назва товару
- description або description_ua і/або description_ru - назва товару
deleteProductList - видалення товарів.
Пошук ведеться по outside_url або id
вхідні параметри
list{
- id - ID товару
- outside_url - зовнішній url
}
вихідні дані
- total - кількість оброблених записів
- delete - кількість видалених товарів
- product_cn - кількість товарів після видалення
{
- enable - включених
- disable - відключених
}
getShopCategory - отримати список категорій магазину, які будуть оброблятись при додаванні товарів
вихідні дані
list{
- id - ID
- name - ідентифікатор категорії у вашій базі даних (рекомендуєм використовувати URL категорії на вашому сайті)
- status - статус для обробки ()
- is_new - правила не визначені
- parse - буде оброблятись
- no_parse - не оброблятиметься
}
setShopCategory - додати категорії магазину які необхідно обробляти при додаванні товарів
вхідні параметри
list{
- name - ідентифікатор категорії у вашій базі даних (рекомендуєм використовувати URL категорії на вашому сайті)
- description - опис, або назва категорії (необхіднно для пришвидшення визначення правил обробки)
}
вихідні дані
- total - кількість поданих категорій
- insert - кількість доданих категорій
- isset - кількість раніше доданих категорій
getOrderList - отримати список покупок
вхідні параметри
- date_from - період з
- date_to - період по
вихідні дані
- id - ID покупки
- date - дата покпки
- name - назва товару
- code - код товару
- inmg - зображення товару
- product_id - ID товару на порталі
- price - ціна товару
- price_special - ціна товару зі знижкою
- cur_status - ID статусу покупки
- status - статус покупки
- status_date - дата встановлення статусу покупки
- purchase_comment - коментар до покупки
- buyer_name - імя покупця
- buyer_last_name - прізвище покупця
- buyer_email - email покупця
- buyer_phone - телефон покупця