Разработка сайтов / Интернет-магазины
API для магазинов в системе uCoz
Синхронизация сайта со сторонним сервисом - get запрос, json ответ, которые в атоматическом режиме будут выводить на моем сайте информацию по товару
- Наименование товара; Изображение товара; Розничная цена; Наличие товара на складе
Примеры работы с API:
URL: api2.ashx
Параметры (все параметры являются обязательными):
- id - идентификатор объекта key - ключ пользователя(user_key) для доступа к API type - тип получаемых данных. Возможные значения:
- 0 - получить список дочерних каталогов 1 - получить список продукции в указанном каталоге 2 - получить информацию о конкретной продукции
- 5dc1dd77-e1e3-11e3-8af7-001e6733a62e - Склад Москва 5dc1dd78-e1e3-11e3-8af7-001e6733a62e - Склад Нижний Новгород 1d448de8-5c60-11e5-a968-001e6733a62f - Склад завода PARADYZ
- json или не указан: - получать данные в фомате json xml - получать данные в формате xml
Чтобы получить ключ для работы с API необходимо связаться с администратором по электронной почте *****@***com
Сценарий работы клиента
1. Отправка GET запроса для получения дочерних каталогов для данного каталога
Пример запроса: http://api. /api2.ashx? id=100&key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&type=0
- id=100 - идентификатор каталога, для которого нужно получить список дочерних каталогов. Если параметр id не указан в запросе, то будет возвращен список каталогов нулевого уровня key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX - ключ пользователя для доступа к API. type=0 - тип получаемых данных. В данном случае - список дочерних каталогов.
Ответ для данного запроса (в формате JSON):
[{
"catalogName":"ATLAS CONCORDE","
catalogID":478,
"catalogLevel":3,
"ParentID":470
},
{"catalogName":"Керамический гранит (керамогранит) ESTIMA (Россия)",
"catalogID":480,
"catalogLevel":3,
"ParentID":470}]
catalogName - название каталога
catalogID - идентификатор каталога
catalogLevel - уровень вложенности каталога
parentID - идентификатор родительского каталога. Значение -1 означает, что данный каталог является каталогом верхнего уровня
2. Отправка GET запроса для получения списка продукции, относящейся к выбранному каталогу
Пример запроса: http://api. /api2.ashx? id=100&key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&type=1
- id=100 - идентификатор каталога, для которого нужно получить список продукции. key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX - ключ пользователя для доступа к API. type=1 - тип получаемых данных. В данном случае - список продукции каталога.
Ответ для данного запроса (в формате JSON):
[
{
"PropertyList":[
],
"UID":9738,
"Article":"",
"ProductName":"Наименование",
"Brand":"ESTIMA",
"ProductCollection":"",
"FabrikaCountry":"РОССИЯ",
"Color":"Песочный",
"AppointmentCollection":"Керамогранит",
"Appointment":"Напольная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=9738",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=9738",
"Height":"1200",
"Width":"600",
"Thikness":"0,0000",
"PriceOpt":"768",
"Price":"1095",
"Discount":"0",
"Weigth":"27,488",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":0
},
{
"PropertyList":[
],
"UID":9737,
"Article":"",
"Brand":"ESTIMA",
"ProductCollection":"",
"FabrikaCountry":"РОССИЯ",
"Color":"Серый",
"AppointmentCollection":"Керамогранит",
"Appointment":"Напольная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=9737",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=9737",
"Height":"1200",
"Width":"600",
"Thikness":"0,0000",
"PriceOpt":"768",
"Price":"1095",
"Discount":"0",
"Weigth":"27,488",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":0
}]
PropertyList - характеристики и остатки
ProductName - наименование продукции
UID - идентификатор продукции
Article - артикул производителя
Brand - Бренд/фабрика
ProductCollection - Коллекция
FabrikaCountry - Страна производства
Color - Цвет
AppointmentCollection - Назначение коллекции
Appointment - Назначение элемента
SmallPhoto - Уменьшеное изображение
Photo - изображение
Height - высота (мм)
Width - ширина (мм)
Thikness - толщина (мм)
PriceOpt - цена оптовая
Price - цена
Discount - скидка
Weigth - вес
Remain - кол-во
Reserve - если значение равно "1", то есть возможность снять дополнительное кол-во товара с резверва другого контрагента
UnitName - базовая единица измерения
BoxQnt - кол-во в упаковке
3. Отправка GET запроса для получения информации о продукции
Пример запроса: http://api. /api2.ashx? id=XXX&key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&type=2
- id=XXX - идентификатор продукции, о которой нужно получить информацию (UID). key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX - ключ пользователя для доступа к API. type=2 - тип получаемых данных. В данном случае - информация о продукции.
Ответ для данного запроса (в формате JSON):
[{
"PropertyList":[
],
"UID":9738,
"Article":"",
"ProductName":"Наименование",
"Brand":"ESTIMA",
"ProductCollection":"",
"FabrikaCountry":"РОССИЯ",
"Color":"Песочный",
"AppointmentCollection":"Керамогранит",
"Appointment":"Напольная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=9738",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=9738",
"Height":"1200",
"Width":"600",
"Thikness":"0,0000",
"PriceOpt":"768",
"Price":"1095",
"Discount":"0",
"Weigth":"27,488",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":0
}]
PropertyList - характеристики и остатки
UID - идентификатор продукции
ProductName - наименование продукции
Article - артикул производителя
Brand - Бренд/фабрика
ProductCollection - Коллекция
FabrikaCountry - Страна производства
Color - Цвет
AppointmentCollection - Назначение коллекции
Appointment - Назначение элемента
SmallPhoto - Уменьшеное изображение
Photo - изображение
Height - высота (мм)
Width - ширина (мм)
Thikness - толщина (мм)
PriceOpt - цена оптовая
Price - цена
Discount - скидка
Weigth - вес
Remain - кол-во
Reserve - если значение равно "1", то есть возможность снять дополнительное кол-во товара с резверва другого контрагента
UnitName - базовая единица измерения
BoxQnt - кол-во в упаковке
4. Отправка GET запроса для получения всей продукции
Пример запроса: http://api. /api2.ashx? key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&type=3&pz=10&page=0
- pz=10 - кол-во элементов на странице (необязательный параметр). page=0 - номер получаемой страницы (необязательный параметр). key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX - ключ пользователя для доступа к API. type=3 - тип получаемых данных. В данном случае - список продукции.
Ответ для данного запроса (в формате JSON):
{
"list":[
{
"PropertyList":[
{
"Name":"",
"Quantity":"0 м2"
}
],
"UID":14132,
"ProductName":"Наименование",
"Article":"",
"Brand":"",
"ProductCollection":"Century",
"FabrikaCountry":"ИСПАНИЯ",
"Color":"Серый, Коричневый, Многоцветный",
"AppointmentCollection":"Плитка для ванной, Плитка для гостиной, Плитка для коридора, Плитка для кухни, Плитка для фартука",
"Appointment":"Настенная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=14132",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=14132",
"Height":"200",
"Width":"200",
"Thikness":"0,0000",
"PriceOpt":"0",
"Price":"0",
"Discount":"0",
"Weigth":"13,581",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":1
},
{
"PropertyList":[
{
"Name":"",
"Quantity":"0 м2"
}
],
"UID":14133,
"ProductName":"Наименование",
"Article":"",
"Brand":"",
"ProductCollection":"Century",
"FabrikaCountry":"ИСПАНИЯ",
"Color":"Серый, Коричневый",
"AppointmentCollection":"Плитка для ванной, Плитка для гостиной, Плитка для коридора, Плитка для кухни, Плитка для фартука",
"Appointment":"Настенная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=14133",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=14133",
"Height":"200",
"Width":"200",
"Thikness":"0,0000",
"PriceOpt":"0",
"Price":"0",
"Discount":"0",
"Weigth":"13,581",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":1
}
],
"total":5398
}
list - список продукции
total - общее кол-во продукции (всего)
Характеристики продукции:
PropertyList - характеристики и остатки
UID - идентификатор продукции
ProductName - наименование продукции
Article - артикул производителя
Brand - Бренд/фабрика
ProductCollection - Коллекция
FabrikaCountry - Страна производства
Color - Цвет
AppointmentCollection - Назначение коллекции
Appointment - Назначение элемента
SmallPhoto - Уменьшеное изображение
Photo - изображение
Height - высота (мм)
Width - ширина (мм)
Thikness - толщина (мм)
PriceOpt - цена оптовая
Price - цена
Discount - скидка
Weigth - вес
Remain - кол-во
Reserve - если значение равно "1", то есть возможность снять дополнительное кол-во товара с резверва другого контрагента
UnitName - базовая единица измерения
BoxQnt - кол-во в упаковке
Примеры работы с API:
URL: api2.ashx
Параметры (все параметры являются обязательными):
- id - идентификатор объекта key - ключ пользователя(user_key) для доступа к API type - тип получаемых данных. Возможные значения:
- 0 - получить список дочерних каталогов 1 - получить список продукции в указанном каталоге 2 - получить информацию о конкретной продукции
- 5dc1dd77-e1e3-11e3-8af7-001e6733a62e - Склад Москва 5dc1dd78-e1e3-11e3-8af7-001e6733a62e - Склад Нижний Новгород 1d448de8-5c60-11e5-a968-001e6733a62f - Склад завода PARADYZ
- json или не указан: - получать данные в фомате json xml - получать данные в формате xml
Чтобы получить ключ для работы с API необходимо связаться с администратором по электронной почте *****@***com
Сценарий работы клиента
1. Отправка GET запроса для получения дочерних каталогов для данного каталога
Пример запроса: http://api. /api2.ashx? id=100&key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&type=0
- id=100 - идентификатор каталога, для которого нужно получить список дочерних каталогов. Если параметр id не указан в запросе, то будет возвращен список каталогов нулевого уровня key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX - ключ пользователя для доступа к API. type=0 - тип получаемых данных. В данном случае - список дочерних каталогов.
Ответ для данного запроса (в формате JSON):
[{
"catalogName":"ATLAS CONCORDE","
catalogID":478,
"catalogLevel":3,
"ParentID":470
},
{"catalogName":"Керамический гранит (керамогранит) ESTIMA (Россия)",
"catalogID":480,
"catalogLevel":3,
"ParentID":470}]
catalogName - название каталога
catalogID - идентификатор каталога
catalogLevel - уровень вложенности каталога
parentID - идентификатор родительского каталога. Значение -1 означает, что данный каталог является каталогом верхнего уровня
2. Отправка GET запроса для получения списка продукции, относящейся к выбранному каталогу
Пример запроса: http://api. /api2.ashx? id=100&key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&type=1
- id=100 - идентификатор каталога, для которого нужно получить список продукции. key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX - ключ пользователя для доступа к API. type=1 - тип получаемых данных. В данном случае - список продукции каталога.
Ответ для данного запроса (в формате JSON):
[
{
"PropertyList":[
],
"UID":9738,
"Article":"",
"ProductName":"Наименование",
"Brand":"ESTIMA",
"ProductCollection":"",
"FabrikaCountry":"РОССИЯ",
"Color":"Песочный",
"AppointmentCollection":"Керамогранит",
"Appointment":"Напольная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=9738",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=9738",
"Height":"1200",
"Width":"600",
"Thikness":"0,0000",
"PriceOpt":"768",
"Price":"1095",
"Discount":"0",
"Weigth":"27,488",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":0
},
{
"PropertyList":[
],
"UID":9737,
"Article":"",
"Brand":"ESTIMA",
"ProductCollection":"",
"FabrikaCountry":"РОССИЯ",
"Color":"Серый",
"AppointmentCollection":"Керамогранит",
"Appointment":"Напольная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=9737",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=9737",
"Height":"1200",
"Width":"600",
"Thikness":"0,0000",
"PriceOpt":"768",
"Price":"1095",
"Discount":"0",
"Weigth":"27,488",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":0
}]
PropertyList - характеристики и остатки
ProductName - наименование продукции
UID - идентификатор продукции
Article - артикул производителя
Brand - Бренд/фабрика
ProductCollection - Коллекция
FabrikaCountry - Страна производства
Color - Цвет
AppointmentCollection - Назначение коллекции
Appointment - Назначение элемента
SmallPhoto - Уменьшеное изображение
Photo - изображение
Height - высота (мм)
Width - ширина (мм)
Thikness - толщина (мм)
PriceOpt - цена оптовая
Price - цена
Discount - скидка
Weigth - вес
Remain - кол-во
Reserve - если значение равно "1", то есть возможность снять дополнительное кол-во товара с резверва другого контрагента
UnitName - базовая единица измерения
BoxQnt - кол-во в упаковке
3. Отправка GET запроса для получения информации о продукции
Пример запроса: http://api. /api2.ashx? id=XXX&key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&type=2
- id=XXX - идентификатор продукции, о которой нужно получить информацию (UID). key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX - ключ пользователя для доступа к API. type=2 - тип получаемых данных. В данном случае - информация о продукции.
Ответ для данного запроса (в формате JSON):
[{
"PropertyList":[
],
"UID":9738,
"Article":"",
"ProductName":"Наименование",
"Brand":"ESTIMA",
"ProductCollection":"",
"FabrikaCountry":"РОССИЯ",
"Color":"Песочный",
"AppointmentCollection":"Керамогранит",
"Appointment":"Напольная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=9738",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=9738",
"Height":"1200",
"Width":"600",
"Thikness":"0,0000",
"PriceOpt":"768",
"Price":"1095",
"Discount":"0",
"Weigth":"27,488",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":0
}]
PropertyList - характеристики и остатки
UID - идентификатор продукции
ProductName - наименование продукции
Article - артикул производителя
Brand - Бренд/фабрика
ProductCollection - Коллекция
FabrikaCountry - Страна производства
Color - Цвет
AppointmentCollection - Назначение коллекции
Appointment - Назначение элемента
SmallPhoto - Уменьшеное изображение
Photo - изображение
Height - высота (мм)
Width - ширина (мм)
Thikness - толщина (мм)
PriceOpt - цена оптовая
Price - цена
Discount - скидка
Weigth - вес
Remain - кол-во
Reserve - если значение равно "1", то есть возможность снять дополнительное кол-во товара с резверва другого контрагента
UnitName - базовая единица измерения
BoxQnt - кол-во в упаковке
4. Отправка GET запроса для получения всей продукции
Пример запроса: http://api. /api2.ashx? key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&type=3&pz=10&page=0
- pz=10 - кол-во элементов на странице (необязательный параметр). page=0 - номер получаемой страницы (необязательный параметр). key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX - ключ пользователя для доступа к API. type=3 - тип получаемых данных. В данном случае - список продукции.
Ответ для данного запроса (в формате JSON):
{
"list":[
{
"PropertyList":[
{
"Name":"",
"Quantity":"0 м2"
}
],
"UID":14132,
"ProductName":"Наименование",
"Article":"",
"Brand":"",
"ProductCollection":"Century",
"FabrikaCountry":"ИСПАНИЯ",
"Color":"Серый, Коричневый, Многоцветный",
"AppointmentCollection":"Плитка для ванной, Плитка для гостиной, Плитка для коридора, Плитка для кухни, Плитка для фартука",
"Appointment":"Настенная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=14132",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=14132",
"Height":"200",
"Width":"200",
"Thikness":"0,0000",
"PriceOpt":"0",
"Price":"0",
"Discount":"0",
"Weigth":"13,581",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":1
},
{
"PropertyList":[
{
"Name":"",
"Quantity":"0 м2"
}
],
"UID":14133,
"ProductName":"Наименование",
"Article":"",
"Brand":"",
"ProductCollection":"Century",
"FabrikaCountry":"ИСПАНИЯ",
"Color":"Серый, Коричневый",
"AppointmentCollection":"Плитка для ванной, Плитка для гостиной, Плитка для коридора, Плитка для кухни, Плитка для фартука",
"Appointment":"Настенная плитка",
"SmallPhoto":"http://api. /image. ashx? mode=product2\u0026maxwidth=200\u0026maxheight=200\u0026id=14133",
"Photo":"http://api. /image. ashx? mode=product2\u0026maxwidth=650\u0026maxheight=650\u0026id=14133",
"Height":"200",
"Width":"200",
"Thikness":"0,0000",
"PriceOpt":"0",
"Price":"0",
"Discount":"0",
"Weigth":"13,581",
"Remain":"0",
"Reserve":"0",
"UnitName":"м2",
"BoxQnt":1
}
],
"total":5398
}
list - список продукции
total - общее кол-во продукции (всего)
Характеристики продукции:
PropertyList - характеристики и остатки
UID - идентификатор продукции
ProductName - наименование продукции
Article - артикул производителя
Brand - Бренд/фабрика
ProductCollection - Коллекция
FabrikaCountry - Страна производства
Color - Цвет
AppointmentCollection - Назначение коллекции
Appointment - Назначение элемента
SmallPhoto - Уменьшеное изображение
Photo - изображение
Height - высота (мм)
Width - ширина (мм)
Thikness - толщина (мм)
PriceOpt - цена оптовая
Price - цена
Discount - скидка
Weigth - вес
Remain - кол-во
Reserve - если значение равно "1", то есть возможность снять дополнительное кол-во товара с резверва другого контрагента
UnitName - базовая единица измерения
BoxQnt - кол-во в упаковке
