Описание

Используя наше API Вы можете получить следующие данные:

Доступ к API не ограничен по количеству запросов на единицу времени.
Доступ ограничен по IP-адресу.

Для получения доступа к API необходимо предоставть ip-адрес Вашему менеджеру.
Контактные данные менеджера можно найти в личном кабинете.

Технические данные

Способ отправки данных клиентом на сервер POST
Envelope JSON-RPC-2.0
SMDVersion: 2.0
Target /api/server_info_demo.php

API сайта построено на стандарте JSONRPC версия 2.0, обмен данными между клиентом и сервером проходит в json формате:
Информация о стандарте:
http://www.jsonrpc.org/specification
http://ru.wikipedia.org/wiki/JSON-RPC#.D0.92.D0.B5.D1.80.D1.81.D0.B8.D1.8F_2.0

- пример ответа сервера на запрос групп uniqom после преобразования json данных
- пример взаимодействия через стандарт JSONRPC : --> {"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id": 1}
<-- {"jsonrpc": "2.0", "result": 19, "id": 1}
1

Пример реализации клиента API uniqom.ru (PHP): Скачать пример, содержимое архива:

client.php - пример реализации клиента к API
CatalogRpcServiceClient.php - класс клиента для работы c API uniqom содержит все описаные методы сервера
jsonrpc/BaseJsonRpcClient.php - базовый класс JSONRPC



Методы API сайта uniqom.ru v 1.0

- GetToken
- GetParameters
- GetPrices
- GetDeposits
- GetAllItems
- GetItemsByGroup
- GetItem
- GetAllGroups
- GetBrand
- GetAllStorages
- GetAllBrands


Метод: GetToken
Краткое описание: Возвращает токен клиента для получения цен, используется в методах : GetItem, GetItemsByGroup , GetAllItems, GetDeposits, GetPrices
Пример вызова: {"jsonrpc":"2.0","id":1,"method":"GetToken","params":{"email":"e-mail","pwd":"1234567"}}
Пример ответа сервера: {"jsonrpc":"2.0","result":{"token":"hwZkPA9AW20cDjGuYHIx2H+90AjWsgn6fnRg"},"id":1}

Описание параметров result:
nameописание
token токен
Параметры вызова
name type description
email string почта аккаунта
pwd string пароль аккаунта
Метод: GetParameters
Краткое описание: Параметры для товаров (кроссы и oem),$type может быть равен oem или marking.

Пример вызова: {"jsonrpc":"2.0","id":2,"method":"GetParameters","params":{"token":"Токен","type":"oem","lim":10,"offset":0}}
Пример ответа сервера: {"jsonrpc":"2.0","result":[{"item_id":"106413","value":"28113-1R100"},{"item_id":"106414","value":"11214-20030"}],"id":2}

Описание параметров result:
nameописание
item_idid товара
valueзначение артикул или oem
Параметры вызова
name type description
token string токен
type string тип может быть равен oem или marking
lim int кол-во записей
offset int начальная запись
Метод: GetPrices
Краткое описание: Цены для товаров
Пример вызова: {"jsonrpc":"2.0","id":null,"method":"GetPrices","params":{"token":"токен","lim":10000,"offset":0}}
Пример ответа сервера:: {"jsonrpc":"2.0","result":[{"id":"20","price":"240.16"},{"id":"21","price":"240.16"}],"id":2}

Описание параметров result:
nameописание
idid товара
priceзначение цены
Параметры вызова
name type description
token string токен
lim int кол-во записей
offset int начальная запись
itemId
Метод: GetDeposits
Краткое описание: Остатки для товаров, параметр $type отвечает за отображение остатков (1- по филиалу общее,2- по складам филиала)
Пример ответа сервера: если параметр = 1: {"jsonrpc":"2.0","result":[{"id":"20","deposit":60},{"id":"21","deposit":40}],"id":2}
Пример ответа сервера: если параметр = 2: {"jsonrpc":"2.0","result":[{"id":"20","storage_id":"56","deposit":null},{"id":"20","storage_id":"74","deposit":null},{"id":"20","storage_id":"76","deposit":null},{"id":"21","storage_id":"56","deposit":null},{"id":"21","storage_id":"74","deposit":null},{"id":"21","storage_id":"76","deposit":null}],"id":2}

Описание параметров result:
nameописание
idid товара
depositостаток
storage_idid склада
Параметры вызова
name type description
token string токен
type int отвечает за отображение остатков (1- по филиалу общее,2- по складам филиала)
Метод: GetAllItems
Краткое описание: Все товары uniqom.ru,
Пример вызова: {"jsonrpc":"2.0","id":4,"method":"GetAllItems","params":{"token":"токен","lim":500,"offset":2600}}
Пример ответа сервера: {"jsonrpc":"2.0","result":[{"header":"\u0410\u0440\u043e\u043c\u0430\u0442\u0438\u0437\u0430\u0442\u043e\u0440 \u0436\u0438\u0434\u043a\u0438\u0439 CRYSTAL ROCK - ITALIAN LEMON", "id":"20", "text":"", "group_id":null, "article":"E-51", "variation":"\u0418\u0422\u0410\u041b\u042c\u042f\u041d\u0421\u041a\u0418\u0419 \u041b\u0415\u041c\u041e\u041d", "picture_files":[{"img100":"http:\/\/uniqom.ru\/uploads\/items\/thumb\/100_100_0_20.jpg", "img210":"http:\/\/uniqom.ru\/uploads\/items\/thumb\/210_210_0_20.jpg", "img130":"http:\/\/uniqom.ru\/uploads\/items\/thumb\/130_80_0_20.jpg", "big":"http:\/\/uniqom.ru\/uploads\/items\/20.jpg"}]}],"id":2}

Описание параметров result:
nameописание
idid товара
headerнаименование товара
brand_idid бренда
group_idid группы
textописание товара
group_idid группы
articleартикул
variationразновидность
picture_filesмассив с картинками
Параметры вызова
name type description
token string токен
lim int кол-во записей
offset int начальная запись
Метод: GetItemsByGroup
Краткое описание: Товары для группы GetItemsByGroup($idgroup,$token='',$lim=0,$offset=0),
Пример вызова: {"jsonrpc":"2.0","id":6,"method":"GetItemsByGroup","params":{"idgroup":206,"token":"токен","lim":0,"offset":0}}
Пример ответа сервера: можно увидеть в методе GetAllItems
Параметры вызова
name type description
idgroup int id группы
token string токен
lim int кол-во записей
offset int начальная запись
Метод: GetItem
Краткое описание: Один товар
Пример вызова: {"jsonrpc":"2.0","id":2,"method":"GetItem","params":{"id": ID_товара,"token": "токен"}}
Пример ответа сервера::{"jsonrpc":"2.0","result":[{"header":"\u0410\u0440\u043e\u043c\u0430\u0442\u0438\u0437\u0430\u0442\u043e\u0440 \u0436\u0438\u0434\u043a\u0438\u0439 CRYSTAL ROCK - ITALIAN LEMON", "brand_id":"20", "group_id":"20""id":"20", "text":"", "article":"E-51", "variation":"\u0418\u0422\u0410\u041b\u042c\u042f\u041d\u0421\u041a\u0418\u0419 \u041b\u0415\u041c\u041e\u041d", "picture_files":[{"img100":"http:\/\/uniqom.ru\/uploads\/items\/thumb\/100_100_0_20.jpg", "img210":"http:\/\/uniqom.ru\/uploads\/items\/thumb\/210_210_0_20.jpg", "img130":"http:\/\/uniqom.ru\/uploads\/items\/thumb\/130_80_0_20.jpg", "big":"http:\/\/uniqom.ru\/uploads\/items\/20.jpg"}]}], "id":2}

Описание параметров result:
nameописание
idid товара
headerнаименование товара
brand_idid бренда
group_idid группы
textописание товара
group_idid группы
articleартикул
variationразновидность
picture_filesмассив с картинками
Параметры вызова
name type description
id int id товара
token string токен
Метод: GetAllGroups
Краткое описание: Группы каталога Uniqom,
Пример вызова: {"jsonrpc":"2.0","id":2,"method":"GetAllGroups","params":[]}
Пример ответа сервера:: {"jsonrpc":"2.0","result":[{"header":"\u0417\u0430\u043f\u0447\u0430\u0441\u0442\u0438","id":"1","parent_id":0},{"header":"\u0425\u0438\u043c\u0438\u044f","id":"2","parent_id":0}],"id":2}

Описание параметров result:
nameописание
idid группы
headerнаименование группы
parent_idid родительской группы
Метод: GetBrand
Краткое описание: Данные по одному бренду ( возвращает описание бренда, описание кодировано base64 )
Пример вызова: {"jsonrpc":"2.0","id":2,"method":"GetBrand","params":{"id":2}}
Пример ответ сервера: {"jsonrpc":"2.0","result":[{"header":"YEC","id":"1","text":"base64_encode текст"}],"id":2}

Описание параметров result:
nameописание
idid группы
headerнаименование брэнда
textописание кодировано base64
Параметры вызова
name type description
id int id бренда
Метод: GetAllStorages
Краткое описание: Доступные склады для пользователя
Пример вызова: {"jsonrpc":"2.0","id":2,"method":"GetAllStorages","params":{"token":"токен"}}
Пример ответа сервера:: {"jsonrpc":"2.0","result":[{"header":"\u0422\u0445","full_header":"\u0422\u0443\u0445\u0430\u0447\u0435\u0432\u0441\u043a\u043e\u0433\u043e 48\u0410","address":"\u0426\u0420\u0421 \u0412\u043e\u0441\u0442\u043e\u043a","id":"56"},{"header":"\u04212","full_header":"\u0421\u043a\u043b\u0430\u0434 \u21162 (\u0415\u043d\u0438\u0441\u0435\u0439\u0441\u043a\u0430\u044f)","address":"\u0426\u0420\u0421 \u0412\u043e\u0441\u0442\u043e\u043a","id":"74"},{"header":"\u0426\u0420\u0421","full_header":"\u0426\u0420\u0421 \u0412\u043e\u0441\u0442\u043e\u043a","id":"76"},{"header":"\u0426\u0420\u0421","address":"\u0426\u0420\u0421 \u0412\u043e\u0441\u0442\u043e\u043a","id":"76"}],"id":2}

Описание параметров result:
nameописание
idid склада
headerнаименование краткое
full_headerнаименование полное
addressадрес склада
Параметры вызова
name type description
token string токен
Метод: GetAllBrands
Краткое описание: Все бренды из каталога Uniqom,
Пример вызова: {"jsonrpc":"2.0","id":3,"method":"GetAllBrands","params":[]}
Пример ответ сервера: {"jsonrpc":"2.0","result":[{"header":"YEC","id":"1"},{"header":"OSK","id":"2"}],"id":2}

Описание параметров result:
nameописание
idid бренда
headerнаименование