Вход для партнёров
Хочу стать партнёром
Стать партнёром
Результаты поиска

Оптовое API для клиентов

API представляет набор правил и функций, позволяющих двум разным приложениям взаимодействовать друг с другом (например между 1С и сайтом). API выступает посредником между приложениями, отправляя запросы и ответы.

Для чего это нужно? Автоматизация. Не нужно вручную вносить информацию о товарах (в 1С, на сайт или CRM). Вы можете попросить программиста, который обслуживает Вашу компанию, и он используя наше API автоматизирует этот процесс. Это же касается своевременного обновления цен и остатков.

Для отправки и получения тех самых запросов мы предоставляем следующие типы протоколов и архитектур:

  • XML-RPC — позволяет выполнять обмен функциями между двумя или более сетями. XML-RPC использует XML для описания запросов и ответов, и при помощи протоколов HTTP передает информацию от клиента к серверу.
  • REST API — репрезентативная передача состояния (REST) — это архитектурный стиль, который осуществляет реализацию клиента и сервера независимо друг от друга. Сервисы в REST API взаимодействуют по протоколу HTTP.

XML файлы

Нашим клиентам доступны 3 файла XML, в которых хранятся различные данные. Каждый из файлов обновляется с разной переодичностью.

elements.xml

Файл elements.xml — содержит основную информацию о товарах (название, код товара, описание, фотографии и т.п.). Ещё он содержит информацию о структуре каталога, название категорий и какие товары в них входят. Обновляется он один раз в сутки. Давайте рассмотрим структуру файла elements.xml

Элемент Описание
xml

Стандартный XML-заголовок. Должен начинаться с первой строки, с нулевого символа.

xml_catalog

Мы используем в качестве корневого xml элементa: <xml_catalog> с атрибутом date. Этот атрибут сообщает дату и время момента, на который актуальны данные в файле.

categories

Cодержит список категорий. Каждая категория описывается отдельным элементом category.

category

Название категории. Атрибут id - идентификатор категории. Атрибут parentId - это идентификатор категории более высокого уровня (если категория является дочерней). Если parentId не указан, категория считается корневой.

offers

Список товаров. Каждый товар описывается в отдельном элементе offer.

offer

Содержит узел информации о конкретном товаре. Атрибут id - это уникальный код товара.

name

Наименование номенклатуры. Не содержит спецсимволов.

categoryId

Идентификатор категории товара (целое число).

barcode

Штрихкод товара от производителя в формате: EAN-13.

unit

Единица измерения, формат и стандарт данных не регламентирован, обрабатывайте как строковые данные.

images

Родительский узел содержащий информацию о фотографиям к товару. Этот узел содержит дополнительную избыточную информацию, его можно игнорировать. Структура введена для удобства.

count

Содержит информацию о количестве фотографий у товара на текущий момент.

hash

Это расчитанное значение crc32, от последоательной (от 1 до n) конкатенации строковых значений атрибутов hash у элементов picture в узле элемента pictures. Пример конкатенации: crc32("aaaaaabbbbbbcccccc"). Используя это значение, можно оптимизировать проверку о необходимости обновления изображений, чтобы не выкачивать их каждый раз и своевременно удалять и обновлять устаревшие.

pictures

Родительский узел содержащий информацию о ссылках на фотографии к товару.

picture

Ссылка на фотографию к товару. Атрибут hash - содержит crc32 значение хэш-функции файла изображения. Используя этот атрибут, можно оптимизировать обновление только изменившихся фотографий.

description

Текстовое описание товара. Формат не регламентирован. Не содержит спецсимволов.

params

Родительский узел содержащий информацию о свойствах товара. Каждое свойство описывается в отдельном элементе param.

param

Текущее значение свойства. Атрибут name - содержит название свойства. Атрибут type - может принимать четыре значения: список, строка, число, логическое (boolean). Атрибут code - уникальный строковый идентификатор свойства.

price.xml

Файл price.xml — содержит информацию о стоимости товара, по которой вы можете его купить, а также о рекомендуемой розничной цене. Обновляется каждые 6 часов. Давайте рассмотрим структуру файла.

Элемент Описание
xml

Стандартный XML-заголовок. Должен начинаться с первой строки, с нулевого символа.

xml_catalog

Мы используем в качестве корневого xml элементa: <xml_catalog> с атрибутом date. Этот атрибут сообщает дату и время момента, на который актуальны данные в файле.

elements

Cодержит список товаров. Каждый товар описывается отдельным элементом element.

element

Текущая стоимость товара в Российских рублях. Атрибут id - уникальный идентификатор товара.

quantity.xml

Файл quantity.xml — содержит информацию о текущих остатках товара на нашем складе. Обновляется каждые 30 минут. Рассмотрим структуру файла:

Элемент Описание
xml

Стандартный XML-заголовок. Должен начинаться с первой строки, с нулевого символа.

xml_catalog

Мы используем в качестве корневого xml элементa: <xml_catalog> с атрибутом date. Этот атрибут сообщает дату и время момента, на который актуальны данные в файле.

elements

Cодержит список товаров. Каждый товар описывается отдельным элементом element.

element

Текущие остатки товара на нашем складе. Атрибут id - уникальный идентификатор товара.

REST JSON

Текущее состояние отключено по техническим причинам. Позволяет не только получать информацию о товарах, но и добавлять их в корзину, оформлять заказы.