API для импорта товаров
REST API для работы с базой товаров nzeta
- 1. Общие сведения о REST API
- 2. Принцип авторизации и взаимодействия
- 3. Список команд API
- 4. Команды API и примеры доступных сценариев
- 4.1 Команда для получения информации о структуре
- 4.2 Команда для получения шаблонов описания категорий структуры
- 4.3 Команда для получения информации о товарах
- 4.4 Команда для получения шаблонов описания товаров
- 4.5 Команда для получения справочника назначений
- 4.6 Команда для получения изображений товаров
- 4.7 Команда для получения документов для товаров
- 4.8 Команда для получения масок свойств
- 4.9 Команда для получения групп свойств
- 4.10 Команда для получения назначений свойств
- 4.11 Команда для получения справочника свойств
- 4.12 Команда для получения значений для свойств списочного типа
- 4.13 Команда для получения свойств товаров
- 4.14 Команда для получений цен и остатков
1. Общие сведения о REST API
API позволяет получать полную информацию о товарах нашей компании.
API создано для решения следующих задач:
- Получение актуальных сведений о структуре категорий
- Получение информации о товарах
- Получение информации о свойствах товаров
- Получение шаблонов описаний товаров и категорий
Интеграция является односторонней и создана для получения необходимых данных нашими партнерами.
Взаимодействие производится по протоколу HTTPS. Авторизация осуществляется по авторизационному ключу полученному в процессе настройки интеграции.
В случае возникновения вопросов вы можете написать на почту технической поддержки api@nzeta.ru
2. Принцип авторизации и взаимодействия
HTTPS:
- Запросы к API принимаются только по протоколу HTTPS. Это обеспечивает достаточный уровень безопасности для общения систем через Интернет.
- В целях безопасности ваших данных, пожалуйста, реализуйте прием запросов на своей стороне также с использованием HTTPS.
Ключ (token):
- Дополнительно для авторизации каждого запроса к API используется специальный ключ (token). Получить его можно написав запрос на почту api@nzeta.ru
- Ключи создаются один раз при настройке интеграции. При необходимости, вы можете изменить ключ направив нам запрос на почту api@nzeta.ru
Запросы
- Запросы необходимо отправлять на адрес https://base.nzeta.ru/api.
Пожалуйста, подготовьте методы в соответствии с описанием в этой инструкции. - В теле запроса в специальном поле «token» необходимо всегда передавать специальный ключ.
Запрос к API состоит из следующих элементов:
- Основной URL запроса: https://base.nzeta.ru/api • Ресурс (например: /structure.php) • Параметры POST-запроса (в кодировке UTF-8)
Ответы
- Все ответы на запросы API присылает в формате JSON.
3. Список команд API
structure
structure_description
items items_description
purpose_name
items_pictute
docs
mask
properties_group
properties_purpose
properties
properties_values
properties_items
4. Команды API и примеры доступных сценариев
4.1 Команда для получения информации о структуре
Данная команда позволяет получить список всех категорий нашей номенклатуры. Так же при передаче идентификатора можно получить конкретную категорию.
Табл 1. - Параметры POST-запроса для получения информации о структуре
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
site | String | Идентификатор сайта 2- для сайта nzeta.ru |
Необязательные параметры | ||
id | Int | Идентификатор категории |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/structure.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq site = 1 |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"5201","s_id":"101","p_id":"0","name":"Наконечники, гильзы и соединители»,"site":"2"}] id - идентификатор категории |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.2 Команда для получения шаблонов описания категорий структуры
Данная команда позволяет получить шаблон описания категории. Так же при передаче идентификатора можно получить конкретный шаблон описания категории.
Табл 2. - Параметры POST-запроса для получения шаблонов описания категорий структуры
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
d_id | Int | Идентификатор категории для которой нужно получить описание |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/structure_description.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"3","d_id":"53","descr":"<p>\r\n <strong>Наконечники кабельные медные луженые ТМЛ<\/strong> используются для оконцевания проводов и кабелей с медными жилами сечением от 2,5 до 240 мм<sup>2<\/sup> и применяются для кабелей напряжением до 35 кВ. Наконечники закрепляются на жилах опрессовкой.\r\n<\/p>\r\n<p>\r\n <strong>Наконечники ТМЛ<\/ strong> изготавливаются из медной трубы марки М2 с защитным покрытием олово-висмут (электролитическое лужение). id - идентификатор шаблона описания категории |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.3 Команда для получения информации о товарах
Данная команда позволяет получить информацию о товарах. Так же при передаче идентификатора можно получить информацию о конкретном товаре.
Табл 3. - Параметры POST-запроса для получения информации о товарах
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор товара |
guid | String | Внутренний идентификатор товара |
parentguid | String | Внутренний идентификатор родительской категории товара |
artikul | String | Артикул товара |
TNVED | String | Код товара по ТН ВЭД |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/items.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"2","name":"Трубка жильная 33\/8-0,8 «,"guid":"125efa83-302d-11e1-8096-984be16c89d8","parentguid":"125 efa80-302d-11e1-8096-984be16c89d8","artikul":"ka4000112","category ":"CZ","TNVED":"2147483647","sertRequired":"1","volumeNumerator":" 871","volumeDenominator":"1000000","weightNumerator":"0.083","wei ghtDenominator":"1","edIzm":"шт","volumeEdIzm":"кг","inPrice":"1","b arcode":"0"}] id - идентификатор товара name - название товара |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.4 Команда для получения шаблонов описания товаров
Данная команда позволяет получить шаблон описания товаров. Так же при передаче параметра можно получить конкретный шаблон описания товара.
Табл 4. - Параметры POST-запроса для получения шаблонов описания товаров.
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
d_id | Int | Идентификатор шаблона товара для которого нужно получить описание |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/items_description.php Token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"3","d_id":"53","descr":"\r\n Наконечники кабельные медные луженые ТМЛ<\/strong> используются для оконцевания проводов и кабелей с медными жилами сечением от 2,5 до 240 мм2<\/sup> и применяются для кабелей напряжением до 35 кВ. Наконечники закрепляются на жилах опрессовкой.\r\n<\/p>\r\n \r\n Наконечники ТМЛ<\/strong> изготавливаются из медной трубы марки М2 с защитным покрытием олово-висмут (электролитическое лужение). Наконечник одевается на жилу кабеля и опрессовывается гидравлическим или ручным прессом. Такой метод жестко скрепляет наконечник и конец кабеля, обеспечивая надежное соединение. Олово-висмутовое покрытие позволяет использовать наконечники в агрессивной среде без боязни разрушения основного материала. \r\n<\/p>»}] id - идентификатор шаблона описания товара |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.5 Команда для получения справочника назначений
Данная команда позволяет получить список назначений. Так же при передаче параметра можно получить конкретное название назначения.
Табл 5. - Параметры POST-запроса для получения назначений
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор названия назначения |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/purpose_name.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"1","name":"Для паспорта»}] id - идентификатор названия назначения |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.6 Команда для получения изображений товаров
Данная команда позволяет получить список изображений товаров. Так же при передаче параметра можно получить конкретное изображение для товара.
Табл 6. - Параметры POST-запроса для получения изображений товаров
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор изображения для товара |
z_id | String | Внутренний идентификатор товара guid |
type | Int | Идентификатор назначения |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/items_picture.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq z_id = ac2337b7-f7d4-11e1-bb98-984be16c89d8 type = 1 |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"1","z_id":"ac2337b7-f7d4-11e1- bb98-984be16c89d8","photo":"https:\/\/base.nzeta.ru\/images\/photo\/ 202010021405561261628002.jpg","type":"2"}] id - идентификатор изображения для товара |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.7 Команда для получения документов для товаров
Данная команда позволяет получить список документов для товаров. Так же при передаче параметра можно получить конкретный документ для товара.
Табл 7. - Параметры POST-запроса для получения документов для товаров
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор изображения для товара |
z_id | String | Идентификатор товара |
type | Int | Идентификатор назначения |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/items_docs.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq z_id = f086e9bb-682e-11e6-84ae-001e67657cbf type = 2 |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"1","z_id":"ac2337b7-f7d4-11e1- bb98-984be16c89d8","photo":"https:\/\/base.nzeta.ru\/images\/photo\/ 202010021405561261628002.jpg","type":"2"}] id - идентификатор документа |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.8 Команда для получения масок для свойств
Данная команда позволяет получить список масок для свойств товаров. Так же при передаче идентификатора можно получить конкретную маску.
Табл 8. - Параметры POST-запроса масок для получения свойств товаров
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор маски |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/mask.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"2","name":"Особый артикул","format":"X0-XX-00"}] id - идентификатор маски |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.9 Команда для получения групп свойств
Данная команда позволяет получить названия групп свойств. Так же при передаче параметра можно получить конкретную группу свойств.
Табл 9. - Параметры POST-запроса групп свойств
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор группы свойств |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/properties_group.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"1","parent":"0","nas":"0","cat_id":"[\"2142aa65-1e5f-11e2- af2d-984be16c89d8\",\"119b275c-9fb2-11db-acf6-001485e6b57c\", \"119b2789-9fb2-11db-acf6-001485e6b57c\",\"abbb4567-a216-11dbacf6-001485e6b57c\",\"119b2794-9fb2-11db-acf6-001485e6b57c\", \"55887d6a-39be-11eb-ba8c-ac1f6b74a363\"]","name":"Общ. Размер"}] id - идентификатор группы свойств |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.10 Команда для получения назначений свойств
Данная команда позволяет получить назначение свойств. Так же при передаче идентификатора можно получить конкретное назначение свойства.
Табл 10. - Параметры POST-запроса для получения назначений свойств
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор назначения свойства |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/properties_purpose.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"3","name":"Для сайта nzeta"}] id - идентификатор назначения свойства |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.11 Команда для получения справочника свойств
Данная команда позволяет получить список свойств. Так же при передаче параметра можно получить конкретное свойство.
Табл 11. - Параметры POST-запроса для получения списка свойств
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
site | String | Идентификатор сайта 2- для сайта nzeta.ru |
Необязательные параметры | ||
id | Int | Идентификатор изображения для товара |
g_id | Int | Идентификатор группы свойства |
type | Int | Тип свойств 1 - интервальный |
p_type | Int | Назначение свойства |
code | String | Код свойства |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/properties.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq site = 1 |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"24","act":"1","g_id":"[\"2\",\"11\"]","name":"Материал уплотнителя","type":"2","p_type":"5","mask":"0","site":"1","code":"MA TERIALL_UPL","sort":"0"}] id - идентификатор свойства |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.12 Команда для получения значений для свойств списочного типа
Данная команда позволяет получить значения для свойств списочного типа. Так же при передаче параметра можно получить конкретное значение свойства.
Табл 12. - Параметры POST-запроса для получения значений для свойств списочного типа
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор значения свойства |
p_id | Int | Идентификатор свойства к которому относится значение |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/properties_values.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"9","p_id":"2","parents":"1","val":"18-25\r"}, {"id":"10","p_id":"2","parents":"1","val":"6-12\r"}, {"id":"11","p_id":"2","parents":"1","val":"13-18\r"}] id - идентификатор значения свойства |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.13 Команда для получения свойств товаров
Данная команда позволяет получить свойства товаров. Так же при передаче параметров можно получить значение свойства для конкретного товара.
Табл 13. - Параметры POST-запроса для получения свойств товаров
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
Необязательные параметры | ||
id | Int | Идентификатор значения свойства товара |
item_id | Int | Идентификатор товара для которого установлено свойство |
limit | Int | Ограничение по количеству |
Пример запроса:
POST https://base.nzeta.ru/api/properties_items.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"id":"4","item_id":"b501df4c-7c6e-11e5-8524-001e67657cbf","p_id":" 2","val":"6-12","val1":"","val2":""}, {"id":"14657","item_id":"b501df4c-7c6e-11e5-8524-001e67657cbf","p_i d":"207","val":"М22х1,5","val1":"","val2":""}, {"id":"14658","item_id":"b501df4c-7c6e-11e5-8524-001e67657cbf","p_i d":"22","val":"Кабельный ввод","val1":"","val2":""}] id - идентификатор значения свойства |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |
4.14 Команда для получения цен и остатков
Данная команда позволяет получить цены и остатки товаров.
Табл 14. - Параметры POST-запроса для получения свойств товаров
Параметр | Тип данных | Описание |
---|---|---|
Обязательные параметры | ||
token | String | Ключ (token), предоставленный вам для работы с API |
article | String | Артикул товара |
Пример запроса:
POST https://base.nzeta.ru/api/items_info.php token = $2a$10$d25b7b68a33274f6f983dO4mGUQytl8FMKxUegSF4jHMqIJdJURgq article = zeta10710 |
Выходные данные:
Код | Содержание | Описание |
---|---|---|
200 | [{"amount_msk":"0","amount_nsk":"1800","price":"5.80"}] amount_msk - остатки на складе в Москве |
OK |
400 | { error: "Invalid parameters" } | Переданы некорректные параметры |
401 | { error: "Invalid token" } | Передан неверный ключ (token) |