Товары

Главная   →   Справка   →   API

Получения содержимого папки

Запрос в формате CURL

http://example.ru/api/objects — запрос списка объектов. Поддерживаются методы GET, POST, PUT, DELETE.

Переменные в запросе

  • parent_oid — родительская папка, по-умолчанию 0;
  • type — тип объекта, по-умолчанию не установлен;
  • start — начинать с указанной позиции, по-умолчанию 0;
  • limit — ограничение вывода, по-умолчанию 100;
  • curl --user admin:API_KEY --header 'Content-Type: application/json' -d '{"parent_oid": "parent_oid"}' -X POST 'http://www.example.ru/adm/api/objects'

Пример использования с клиентом API:

$ApiClient = new DiCMSApiClient(
    array(
        'login' => 'admin',
        'api_key' => 'API_KEY',
        'api_url' => 'http://www.example.ru/adm/api/'
    )
);
$folders = $ApiClient->get("objects", array('parent_oid' => 109 ));

Ответ сервера

  • oid — идентификатор объекта в системе.
  • name — имя объекта в системе, которое видит только администратор.
  • url — подстрока URL.
  • template — идентификатор шаблона.
  • parent_oid — идентификатор родителя.
  • sort — сортировка внутри папки.
  • master_oid — идентификатор владельца.
  • access — права доступа.
  • updated — дата обновления.
  • created — дата создания.
Array
(
    [0] => stdClass Object
        (
            [oid] => 110
            [name] => index.html
            [url] => index.html
            [type] => 4
            [template] => 7
            [visible] => 1
            [parent_oid] => 109
            [sort] => 0
            [master_oid] => 3
            [access] => 7777
            [updated] => 2014-04-11 12:50:39
            [created] => 2012-03-16 13:49:24
        )

    [1] => stdClass Object
        (
            [oid] => 111
            [name] => Игрушки
            [url] => games
            [type] => 3
            [template] => 
            [visible] => 1
            [parent_oid] => 109
            [sort] => 2
            [master_oid] => 3
            [access] => 7733
            [updated] => 2015-06-04 17:30:36
            [created] => 2012-03-16 13:49:38
        )

    [2] => stdClass Object
        (
            [oid] => 115
            [name] => Техника
            [url] => tehnika
            [type] => 3
            [template] => 
            [visible] => 1
            [parent_oid] => 109
            [sort] => 3
            [master_oid] => 3
            [access] => 7773
            [updated] => 2015-06-04 17:30:36
            [created] => 2012-03-16 13:51:27
        )
)

Получения содержания объекта

Запрос в формате CURL

http://example.ru/api/objects/OID — запрос информации об объекте. Поддерживаются методы GET, POST, PUT, DELETE.

Переменные в запросе

  • OID — идентификатор объекта

Пример использования с клиентом API:

$ApiClient = new DiCMSApiClient(
    array(
        'login' => 'admin',
        'api_key' => 'API_KEY',
        'api_url' => 'http://www.example.ru/adm/api/'
    )
);
$product = $ApiClient->get("objects/109", array());

Ответ сервера

  • content — содержание объекта в системе, список полей, который вы можете отправить через POST и PUT.
Array
(
    [oid] => 110
    [name] => index.html
    [url] => index.html
    [type] => 4
    [template] => 7
    [visible] => 1
    [parent_oid] => 109
    [sort] => 0
    [master_oid] => 3
    [access] => 7777
    [updated] => 2014-04-11 12:50:39
    [created] => 2012-03-16 13:49:24
    [master_src] => stdClass Object
        (
            [birthDay] => 1983
            [birthMonth] => 6
            [birthYear] => 20
            [email] => info@difocus.ru
            [gender] => male
            [login] => admin
        )
    [content] => stdClass Object
        (
            [name] => Каталог
            [title] => Магазин
            [vlink] => /shop/index.html
        )
)

Теперь, вы знаете, что делать


— или посмотреть пример магазина

Создание интернет-магазина