О Clobucks API

Добро пожаловать на страницу документации API партнерской программы Clobucks.com. С помощью наших API Вы можете реализовать собственный, не зависящий от нас интернет магазин. Данный сервис реализован по протоколу XML-RPC. API доступны адресу:

http://api.clobucks.com/api1.0/
Если Вы ещё ничего не знаете про XML-RPC, то рекомендуем почитать на сайте www.xmlrpc.com
  • Для любителей PHP рекомендуем Zend Framework.

Авторизация

(int) cb.auth((string) login, (string) password, (string) siteHash) — авторизация в системе, необходимо вызывать в начале каждой сессии. Далее при каждом следующем запросе нужно передавать все вернувшиеся cookie. Результатом выполнения функции является id пользователя.

Входные параметры:
(string) login - Ваш логин на Clobucks.com
(string) password - Ваш пароль на Clobucks.com
(string) siteHash - Хеш код, вашего добавленного сайта (http://clobucks.com/links.php)

Методы

В разделе перечислены методы и из описания. Внимание, данный раздел может изменяться.

getSuppliers
cb.getSuppliers()

Возвращает список доступных поставщиков товаров

Пример результата:
<cb>
    <status code="1">ok</status>
    <suppliers>
        <supplier id="505998ea5caf25a003000000">
            <description><![CDATA[ Спортивное питание ]]></description>
            <products_amount>890</products_amount>
        </supplier>
        <supplier id="5049bcd95caf254309000000">
            <description><![CDATA[ Нижнее белье ]]></description>
            <products_amount>6400</products_amount>
        </supplier>
    </suppliers>
</cb>
getCategories
cb.getCategories( (string) supplierID )

Возвращает список доступных категорий товаров у поставщика для интернет магазинов

Входные параметры:
(string) supplierID - ID поставщика
Пример результата:
<cb>
    <status code="1">ok</status>
    <categories>
        <category id="2199">
            <title><![CDATA[ Купальники с мягкой чашкой ]]></title>
            <parent>1255</parent>
        </category>
        <category id="1255">
            <title><![CDATA[ Совместные купальники ]]></title>
            <parent>2025</parent>
        </category>
    </categories>
</cb>
getCategory
cb.getCategory( (int) categoryID, (string) supplierID )

Возвращает информацию по заданной категории

Входные параметры:
(int) categoryID - ID категории
(string) supplierID - ID поставщика
Пример результата:
<cb>
    <status code="1">ok</status>
    <category id="1255">
        <title><![CDATA[ Совместные купальники ]]></title>
        <parent>2025</parent>
        <products>48</products>
    </category>
</cb>
getProductsByCategory
cb.getProductsByCategory( (int) categoryID, (string) supplierID )

Возвращает список продуктов по заданной категории

Входные параметры:
(int) categoryID - ID категории
(string) supplierID - ID поставщика
Пример результата:
<cb>
    <status code="1">ok</status>
	<products>
            <product id="506cd6ea5caf25fd65001a24">
                <title>
                    <![CDATA[ Гольфы 23/26 Charmante арт. 355696 ]]>
                </title>
                <sku>355696</sku>
                <category>2062</category>
                <description>
                    <![CDATA[
                    Оригинальные гольфы с рисунком имитирующим высокие кеды. Высокое качество и уплотненный носочек создадут ощущение полного комфорта при носке изделия. Создайте модный и веселый образ!
                    Состав: хлопок 77%,полиамид 10%,эластан 3%,нейлон 10%
                    Чулочные изделия:
                    Тип изделия: гольфы
                    Свойства: уплотненный мысок
                    Стиль:
                    Стиль: мода
                    Рисунок: принт
                    ]]>
                </description>
                <price>102</price>
                <options>
                    <option>
                        <title><![CDATA[Чёрный, 31-34]]></title>
                        <amount>3</amount>
                    </option>
                </options>
                <images>
                    <image>
                       <![CDATA[http://img.clobucks.com/products/0-4f9515d55caf25d225000097.jpg]]>
                    </image>
                </images>
            </product>
	</products>
</cb>
getProduct
cb.getProduct( (string) productID, (string) supplierID )

Возвращает инвормацию по указанному продукту

Входные параметры:
(string) productID - ID продукта
(string) supplierID - ID поставщика
Пример результата:
<cb>
    <status code="1">ok</status>
    <product id="506cd6ea5caf25fd65001a24">
        <title>
            <![CDATA[ Гольфы 23/26 Charmante арт. 355696 ]]>
        </title>
        <sku>355696</sku>
        <category>2062</category>
        <description>
            <![CDATA[
            Оригинальные гольфы с рисунком имитирующим высокие кеды. Высокое качество и уплотненный носочек создадут ощущение полного комфорта при носке изделия. Создайте модный и веселый образ!
            Состав: хлопок 77%,полиамид 10%,эластан 3%,нейлон 10%
            Чулочные изделия:
            Тип изделия: гольфы
            Свойства: уплотненный мысок
            Стиль:
            Стиль: мода
            Рисунок: принт
            ]]>
        </description>
        <price>102</price>
        <options>
            <option>
                <title><![CDATA[Чёрный, 31-34]]></title>
                <amount>3</amount>
            </option>
        </options>
        <images>
            <image>
               <![CDATA[http://img.clobucks.com/products/0-4f9515d55caf25d225000097.jpg]]>
            </image>
        </images>
    </product>
</cb>
                            
getOrderStatus
cb.getOrderStatus( (string) orderID )

Возвращает статус заказа

Входные параметры:
(string) orderID - ID заказа
Пример результата:
<?xml version="1.0" encoding="utf-8"?>
<cb>
    <status code="1">ok</status>
    <state>4</state>
</cb>
setOrder
cb.setOrder( (array) params )

Добавить новый заказ

Входные параметры:
(array) customer_info - массив, содержащий информацию а покупателе
  • username - имя покупателя
  • email - Email адрес покупателя
  • address - адрес покупателя
  • telephone - телефон
(string) delivery_id - ID доставки. Cм. метод getDeliveries
(array) products - массив продуктов в заказе. Каждый продут передается массивом, состоящим из следующих элементов:
  • product_id - ID продукта
  • option_id - идентификатор опции товара (если есть)
  • qty - количество
(string) comment - коментарий к заказу
Пример запроса (PHP):
$client->cb->setOrder(
            array(
                'customer_info' => array(
                    'username' => 'Иван',
                    'email' => 'test@example.com',
                    'address' => 'Москва',
                    'telephone' => '123456780'
                ),
                'delivery_id' => '1',
                'products' => array(
                    array(
                        'product_id' => '51c24cf13b7d9bb002684c0a',
                        'option_id' => '946831',
                        'qty' => '2'
                    ),
                    array(
                        'product_id' => '51c24cf03b7d9bb002684c09',
                        'option_id' => '681095',
                        'qty' => '4'
                    ),
                ),
                'comment' => 'Коментарий к заказу'
            )
        );
                            
Пример результата:
<?xml version="1.0" encoding="utf-8"?>
<cb>
    <status code="1">ok</status>
    <order>
        <orderid>ff174e327aaa9494ebdc2e0ab177d0228436d47f</orderid>
        <price>1600</price>
    </order>
</cb>
getDeliveries
cb.getDeliveries((string) supplierID)

Получить список возможных вариантов доставки

Входные параметры:
(string) supplierID - ID поставщика
Пример результата:
<?xml version="1.0" encoding="utf-8"?>
<cb>
	<status code="1">ok</status>
	<deliveries>
		<delivery id="4f9333095caf25afd4000000">
			<title><![CDATA[Самовывоз]]></title>
			<description><![CDATA[Вы можете забрать свой заказ в одной из 7ми точек самовывоза (страница Доставка) с понедельника по воскресенье БЕСПЛАТНО.]]></description>
			<price>0</price>
		</delivery>
		<delivery id="4f9333245caf25ffd4000000">
			<title><![CDATA[Почта России]]></title>
			<description><![CDATA[Доставка почтой России осуществляется во все регионы РФ отправлениями первого класса. Сроки доставки от 6 до 18 дней.]]></description>
			<price>350</price>
		</delivery>
		<delivery id="4fa590065caf252e15000000">
			<title><![CDATA[Курьерская доставка]]></title>
			<description><![CDATA[Доставка осуществляется на следующий день после поступления заявки и передачи товара в курьерскую службу.]]></description>
			<price>250</price>
		</delivery>
	</deliveries>
</cb>
getOrderStatuses
cb.getOrderStatuses()

Возвращает возможные статусы заказа

Пример результата:
<cb>
	<status code="1">ok</status>
	<statuses>
		<status id="1">
			<![CDATA[ В обработке ]]>
		</status>
		<status id="2">
			<![CDATA[ Не доставлено ]]>
		</status>
		<status id="3">
			<![CDATA[ Доставлено ]]>
		</status>
		<status id="4">
			<![CDATA[ Отправлено почтой ]]>
		</status>
		<status id="5">
			<![CDATA[ Обработан ]]>
		</status>
		<status id="6">
			<![CDATA[ Передано курьерам ]]>
		</status>
	</statuses>
</cb>

© Clobucks 2014