Описание API

Перечень функций API

http://localhost:2001/apix1/

для доступа к API извне (из интернета) у вашего компьютера должен быть статический IP адрес с открытым портом для API

1 Перечень функций API
2 Аутентификация
3 Общие сведения
4 Пример использования

Аутентификация

Используется Basic access authentication, логин и пароль можно получить в техподдержке

Общие сведения

Для каждого объекта, с которым работает API, возможна фильтрация данных по различным полям, а так же ограничение выборки по количеству возвращаемых объектов, подробнее здесь:

Дополнительные возможности API

Пример использования

1. Получить бренды

Бренд - производитель товара

Функция получения брендов

http://localhost:2001/apix1/Brand

2. Получить группы товаров

Функция получения групп товаров

http://localhost:2001/apix1/ProductCategory

3. Получить товары

Функция получения товаров

http://localhost:2001/apix1/Product

4. Получить типы товаров

Тип товара - присваивается индивидуально каждой группе товаров. Каждый тип товара имеет свои собственные характеристики и, соответственно, такие же характеристики товаров имеют группы, которым присвоен этот тип. Типы товаров могут наследоваться по дереву групп товаров. Т.е. например

Товар → Крупная бытовая техника → Холодильники

У типа Товар будут общие для всех групп товаров характеристики, такие как Вес, Высота, Ширина и т.п., а у типа Холодильники будут характеристики как типа Товар, так и собственного типа Холодильники

Функция получения типов товаров

http://localhost:2001/apix1/ProductType

5. Получить группы характеристик

Группа характеристик - используется для группировки отображения характеристик. Например, характеристики Ширина, Высота, Длина могут быть сгруппированы в Размеры. Групп характеристик может и не быть вообще или вы их можете не использовать, если на вашем сайте не поддерживается отображение групп характеристик.

Функция получения групп характеристик

http://localhost:2001/apix1/ParamGroups

6. Получить единицы измерения

У характеристик могут быть единицы измерения

Функция получения единиц измерения

http://localhost:2001/apix1/ProductUnit

7. Получить характеристики

Характеристики - характеристики товаров, данной функцией возвращается справочник всех характеристик или же отфильтрованный по Типу товара.

Функция получения характеристик

http://localhost:2001/apix1/ParamItems

8. Получить значения характеристик

Значения характеристик - это список возможных вариантов характеристики.

9. Получить характеристики товара

Возвращается массив в виде Ид товара - Ид значения характеристики - данной функцией нужно получать непосредственно значения характеристик товара.

Для быстрого переноса и заполнения характеристик товара, если есть полные права на базу данных MySQL (возможность выполнять LOAD DATA INFILE), можно рассмотреть такой вариант:

1. Получить через апи характеристики, значения характеристик, характеристики товара и сохранить это все в отдельные CSV файлы.

2. Импортировать средствами базы данных полученные CSV файлы во временные таблицы

3. Перенести характеристики из временных таблиц в основные используя ON DUPLICATE KEY UPDATE по id записей из нашей базы

такой вариант позволит добавлять/обновлять миллион значений характеристик за пару минут.

Если полного доступа к базе нет (нельзя выполнить функцию LOAD DATA INFILE), то можно использовать такой же вариант insert/update из временных таблиц, только данные полученные по апи писать сразу во временные таблицы, а не в CSV файл). Прирост скорости будет за счет выполнения обновления основной таблицы за 1 запрос, вместо миллиона апдейтов.

Quad.X