Пользователи

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

Получение групп пользователей

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

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

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

  • parent_oid — родительская папка, по-умолчанию 0;
  • 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/groups'

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

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

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

  • oid — идентификатор объекта в системе.
  • name — имя объекта в системе, которое видит только администратор.
  • url — подстрока URL.
  • template — идентификатор шаблона.
  • parent_oid — идентификатор родителя.
  • sort — сортировка внутри папки.
  • master_oid — идентификатор владельца, как правило 3.
  • access — права доступа.
  • updated — дата обновления.
  • created — дата создания.
Array
(
    [0] => stdClass Object
        (
            [oid] => 2
            [name] => Administrators
            [url] => 
            [type] => 1
            [template] => 
            [visible] => 1
            [parent_oid] => 5
            [sort] => 0
            [master_oid] => 3
            [access] => 7733
            [updated] => 2014-04-11 12:50:39
            [created] => 2012-03-01 16:48:28
        )

    [1] => stdClass Object
        (
            [oid] => 4
            [name] => Guests
            [url] => 
            [type] => 1
            [template] => 
            [visible] => 1
            [parent_oid] => 5
            [sort] => 0
            [master_oid] => 3
            [access] => 7733
            [updated] => 2014-04-11 12:50:39
            [created] => 2012-03-01 16:48:28
        )

    [2] => stdClass Object
        (
            [oid] => 8
            [name] => Зарегистрированные
            [url] => 
            [type] => 1
            [template] => 0
            [visible] => 1
            [parent_oid] => 5
            [sort] => 1
            [master_oid] => 3
            [access] => 7774
            [updated] => 2015-07-27 18:17:48
            [created] => 2012-03-01 16:48:28
        )
)

Получение/изменение данных пользователя

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

http://example.ru/api/users/KEY — запрос информации о пользователе. Поддерживаются методы GET, POST, PUT, DELETE.

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

  • KEY — идентификатор объекта, логин пользователя или емейл пользователя.
  • curl --user admin:API_KEY --header 'Content-Type: application/json' -X GET 'http://www.example.ru/adm/api/users/admin'
  • curl --user admin:API_KEY --header 'Content-Type: application/json' -X GET 'http://www.example.ru/adm/api/users/3'

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

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

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

  • content — содержание объекта в системе, список полей, который вы можете отправить через POST и PUT.
Array
(
    [oid] => 3
    [name] => admin
    [url] => admin
    [type] => 2
    [template] => 0
    [visible] => 1
    [parent_oid] => 2
    [sort] => 0
    [master_oid] => 3
    [access] => 7733
    [updated] => 2015-10-07 20:18:23
    [created] => 2012-03-01 16:48:28
    [content] => stdClass Object
        (
            [address] => г Москва
            [email] => info@difocus.ru
            [gender] => male
            [images] => Array
                (
                    [0] => stdClass Object
                        (
                            [thumb] => /adm/extJS/user/filemanager/bad-file.png
                            [path] => 
                            [length] => 0
                            [width] => 0
                            [height] => 0
                            [name] => Размер
                        )

                )

            [level] => 10
            [login] => admin
            [name] => Администратор
            [org_name] => Рога и копыта
            [phone] => 11222
        )
)

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


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

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