API представляет набор правил и функций, позволяющих двум разным приложениям взаимодействовать друг с другом (например между 1С и сайтом). API выступает посредником между приложениями, отправляя запросы и ответы.
Для чего это нужно? Автоматизация. Не нужно вручную вносить информацию о товарах (в 1С, на сайт или CRM). Вы можете попросить программиста, который обслуживает Вашу компанию, и он используя наше API автоматизирует этот процесс. Это же касается своевременного обновления цен и остатков.
Для отправки и получения тех самых запросов мы предоставляем следующие типы протоколов и архитектур:
Нашим клиентам доступны 3 файла XML, в которых хранятся различные данные. Каждый из файлов обновляется с разной переодичностью.
Файл elements.xml
— содержит основную информацию о товарах (название, код товара, описание, фотографии и т.п.). Ещё он содержит информацию о структуре каталога, название категорий и какие товары в них входят. Обновляется он один раз в сутки. Давайте рассмотрим структуру файла elements.xml
Элемент | Описание |
---|---|
xml |
Стандартный XML-заголовок. Должен начинаться с первой строки, с нулевого символа. |
xml_catalog |
Мы используем в качестве корневого xml элементa: |
categories |
Cодержит список категорий. Каждая категория описывается отдельным элементом |
category |
Название категории. Атрибут |
offers |
Список товаров. Каждый товар описывается в отдельном элементе |
offer |
Содержит узел информации о конкретном товаре. Атрибут |
name |
Наименование номенклатуры. Не содержит спецсимволов. |
categoryId |
Идентификатор категории товара (целое число). |
barcode |
Штрихкод товара от производителя в формате: EAN-13. |
unit |
Единица измерения, формат и стандарт данных не регламентирован, обрабатывайте как строковые данные. |
images |
Родительский узел содержащий информацию о фотографиям к товару. Этот узел содержит дополнительную избыточную информацию, его можно игнорировать. Структура введена для удобства. |
count |
Содержит информацию о количестве фотографий у товара на текущий момент. |
hash |
Это расчитанное значение crc32, от последоательной (от 1 до n) конкатенации строковых значений атрибутов |
pictures |
Родительский узел содержащий информацию о ссылках на фотографии к товару. |
picture |
Ссылка на фотографию к товару. Атрибут |
description |
Текстовое описание товара. Формат не регламентирован. Не содержит спецсимволов. |
params |
Родительский узел содержащий информацию о свойствах товара. Каждое свойство описывается в отдельном элементе |
param |
Текущее значение свойства. Атрибут |
Файл price.xml
— содержит информацию о стоимости товара, по которой вы можете его купить, а также о рекомендуемой розничной цене. Обновляется каждые 6 часов. Давайте рассмотрим структуру файла.
Элемент | Описание |
---|---|
xml |
Стандартный XML-заголовок. Должен начинаться с первой строки, с нулевого символа. |
xml_catalog |
Мы используем в качестве корневого xml элементa: |
elements |
Cодержит список товаров. Каждый товар описывается отдельным элементом |
element |
Текущая стоимость товара в Российских рублях. Атрибут |
Файл quantity.xml
— содержит информацию о текущих остатках товара на нашем складе. Обновляется каждые 30 минут. Рассмотрим структуру файла:
Элемент | Описание |
---|---|
xml |
Стандартный XML-заголовок. Должен начинаться с первой строки, с нулевого символа. |
xml_catalog |
Мы используем в качестве корневого xml элементa: |
elements |
Cодержит список товаров. Каждый товар описывается отдельным элементом |
element |
Текущие остатки товара на нашем складе. Атрибут |
Текущее состояние отключено по техническим причинам
. Позволяет не только получать информацию о товарах, но и добавлять их в корзину, оформлять заказы.