Start

Список пространств имён


  • HDESDK
  • HDESDKAuth
  • HDESDKDepartments
  • HDESDKRequests
  • HDESDKUser
  • HDESDKComment
  • HDESDKTickets
  • HDESDKKnowledgeBase

Список классов


  • SDKInit
  • Auth
  • Departments
  • Requests
  • Ticket
  • User
  • Comment
  • KnowledgeBase

Авторизация

Auth ($user_email, $apikey, $hde_url) - Создание токена доступа

@params
  • $user_email - зарегестрированные в HelpDeskEddy email адрес
  • $apikey - API ключ полбзователя (вы можете найти его в карточке пользователя, ключи видны только главному администратору)
  • $hde_url - адрес вашей HelpDeskEddy системы (пример: "https://example.helpdeskeddy.com")
@return
  • $token - токен доступа

                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');
                                            
                                        

GetToken() - возвращает токен длоступа текущего пользователя

@return
  • $token - токен доступа

                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Получение токена
$start->GetToken();
                                            
                                        

Отделы

DepartmentListGet() - Полечение списка отделов


                                            
//Авторизация пользователя
$start = new HDESDKSDKInit();

//Полечение списка отделов
$start->DepartmentListGet();
                                            
                                        
@return
  • application/json

                                            
{
    "data": {
        {
            "id":1,
            "name":{
                "ru":"Департамент поддержки",
                "en":"Support Department",
                "ua":"Департамент поддержки"
            }
        },{
            "id":2,
            "name":{
                "ru":"Тестивый департамент",
                "en":"Test department",
                "ua":"Тестивый департамент"
        }
    }
}
                                            
                                        

Заявки

TicketGet($options) - Получение заявки по ticket_id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'id'      => 1
);

//Вывод данных запроса
print_r($start->TicketGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

TicketsGet($options) - Получение списка заявок

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
   'page' => 2,
   'search' => 'John',//Поиск по заявкам, строка (необязательный)
   'user_list' => '1,14,22',//Поиск заявок по ID владельца строка (необязательный)
   'owner_list' => '1,44,21',//Поиск заявок по ID исполнителя заявки, строка (необязательный)
   'status_list' => 'open,closed',// Поиск заявок по ID статуса заявки, строка (необязательный)
   'priority_list' => '1,3',//Поиск заявок по ID приоритета заявки, строка (необязательный)
   'type_list' => '0,1',//Поиск заявок по ID типа заявки, строка (необязательный)
   'freeze' => '0',//Фильтр по замороженным заявкам. Значение 0 - только активные заявки, значение 1 - только замороженные заявки, число (необязательный)
   'type_list' => '0,1',//Поиск заявок по ID типа заявки, строка (необязательный)
   'deleted' => '0',//Фильтр по удалённым заявкам. Значение 0 - только активные заявки, значение 1 - только удалённые заявки, число (необязательный)
   'from_date_created' => '2017-12-31 00:00:00',//Дата создания от, строка (необязательный)
   'to_date_created' => '2017-12-31 00:00:00',//Дата создания до, строка (необязательный)
   'from_date_updated' => '2017-12-31 00:00:00',//Дата изменения от, строка (необязательный)
   'to_date_updated' => '2017-12-31 00:00:00',//Дата изменения до, строка (необязательный)
   'order_by' => 'date_created{desc}'//Сортировка заявок, можно указать через запятую. Заявки можно сортировать по параметрам: date_created, date_updated, viewed_by_staff, viewed_by_client. Порядок сортировки {asc} (по возрастанию) и {desc} (по убыванию). Значение по умолчанию: date_created{desc}, строка (необязательный)
)

//Вывод данных запроса
print_r($start->TicketsGet($options));
                                            
                                        
@return
  • application/json

                                            
{
    "data": {
        "10": {
            "id":10,
            "unique_id":"YWP-43009",
            "date_created":"2017-01-13 12:36:58",
            "date_updated":"2017-01-17 13:36:46",
            "title":"New ticket",
            "source": "email",
            "status_id":"open",
            "priority_id":2,
            "type_id":0,
            "department_id":2,
            "department_name":"u041eu0442u0434u0435u043b u043fu043eu0434u0434u0435u0440u0436u043au0438",
            "owner_id":1,
            "owner_name":"Ivan",
            "owner_lastname":"Petrov",
            "owner_email":"ivan.petrov@example.com",
            "user_id":41,
            "user_name":"John",
            "user_lastname":"Doe",
            "user_email":"john.doe@example.com",
            "cc": [],
            "bcc": [],
            "followers": [],
            "ticket_lock":0,
            "sla_date":"13.01.2017 12:36",
            "freeze_date":"null",
            "freeze":0,
            "deleted":0,
            "viewed_by_staff":1,
            "viewed_by_client":1,
            "rate": "like",
            "rate_comment": "Nice",
            "rate_date": "2017-01-17 13:33:30",
            "custom_fields":[
                {
                    "id":3,
                    "field_type":"textarea",
                    "field_value":"4345"
                },{
                    "id":4,
                    "field_type":"checkbox",
                    "field_value":1
                }
            ]
        },
        "9": {
            "id":9,
            "unique_id":"IQV-84397",
            "date_created":"2016-08-15 17:05:19",
            "date_updated":"2017-01-18 11:44:13",
            "title":"Test ticket",
            "source": "email",
            "status_id":"process",
            "priority_id":3,
            "type_id":1,
            "department_id":2,
            "department_name":"u041eu0442u0434u0435u043b u043fu043eu0434u0434u0435u0440u0436u043au0438",
            "owner_id":1,
            "owner_name":"Ivan",
            "owner_lastname":"Petrov",
            "owner_email":"ivan.petrov@example.com",
            "user_id":41,
            "user_name":"John",
            "user_lastname":"Doe",
            "user_email":"john.doe@example.com",
            "cc": [],
            "bcc": [],
            "followers": [],
            "ticket_lock":0,
            "sla_date":"17.01.2017 16:00",
            "freeze_date":"null",
            "freeze":0,
            "deleted":0,
            "viewed_by_staff":1,
            "viewed_by_client":1,
            "rate": "",
            "rate_comment": "",
            "rate_date": "",
            "custom_fields":[
                {
                    "id":3,
                    "field_type":"textarea",
                    "field_value":"4345"
                },{
                    "id":4,
                    "field_type":"checkbox",
                    "field_value":1
                }
            ]
        },
    }, "pagination": {
        "total":"2",
        "per_page":30,
        "current_page":1,
        "total_pages":1
    }
}
                                            
                                        

TicketCreate($options) - Создание новой заявки

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
   'title' => 'Problem with email',//Название заявки, строка (обязательный)
   'description' => 'Problem with email info@example.com',//Текст заявки, строка (обязательный)
   'sla_date' => '01.01.1970 00:00',//Дата и время SLA, дата (необязательный)
   'freeze_date' => '01.01.1970 00:00',//Заморозка заявки до даты и времени, дата (необязательный)
   'status_id' => 'process',// Статус заявки, строка (необязательный)
   'priority_id' => 1,//ID приоритета, число (необязательный)
   'type_id' => 2,//ID типа, число (необязательный)
   'department_id' => 1,//ID департамента, число (необязательный)
   'ticket_lock' => false,//Блокировка заявки. true - блокировать заявку. false - разблокировать заявку, булево (необязательный)
   'owner_id' => 1,//ID исполнителя, число (необязательный)
   'user_id' => 2,//ID владельца заявки, число (необязательный)
   'user_email' => 'email@example.com',//Если не задан ID владельца заявки, то для создания заявки будет использоваться э-почта пользователя, если пользователь не существует, то он будет автоматически создан, строка (необязательный)
   'cc' => array(),//Копия письма, массив почтовых ящиков (необязательный)
   'bcc' => array(),//Скрытая копия письма, массив почтовых ящиков (необязательный)
   'followers' => array(),//Список пользователей следящих за заявкой, пользователь должен быть сотрудником, массив user_id (необязательный)
   'create_from_user' => 1,//Первый ответ в заявке от имени сотрудника – 0, от имени пользователя 1, по умолчанию 1, число (необязательный)
   'custom_fields' => [1 => 3, 2 => 0],//Массив индивидуальных полей заявки, пример: custom_fields[field_id] = value, в случае иерархического поля, необходимо указывать уровень custom_fields[field_id][level] = value, массив (необязательный)
   'files' => array()//приложений, массив файлов (необязательный)

)

//Вывод данных запроса
print_r($start->TicketCreate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

TicketUpdate($options) - Редактирование заявки по ticket_id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
   'id' => 9,//ID заявки, число (обязательный)
   'title' => 'Problem with email',//Название заявки, строка (необязательный)
   'sla_date' => '01.01.1970 00:00',//Дата и время SLA, дата (необязательный)
   'freeze_date' => '01.01.1970 00:00',//Заморозка заявки до даты и времени, дата (необязательный)
   'status_id' => 'process',// Статус заявки, строка (необязательный)
   'priority_id' => 1,//ID приоритета, число (необязательный)
   'type_id' => 2,//ID типа, число (необязательный)
   'department_id' => 1,//ID департамента, число (необязательный)
   'ticket_lock' => false,//Блокировка заявки. true - блокировать заявку. false - разблокировать заявку, булево (необязательный)
   'owner_id' => 1,//ID исполнителя, число (необязательный)
   'user_id' => 2,//ID владельца заявки, число (необязательный)
   'cc' => array(),//Копия письма, массив почтовых ящиков (необязательный)
   'bcc' => array(),//Скрытая копия письма, массив почтовых ящиков (необязательный)
   'followers' => array(),//Список пользователей следящих за заявкой, пользователь должен быть сотрудником, массив user_id (необязательный)
   'custom_fields' => [1 => 3, 2 => 0],//Массив индивидуальных полей заявки, пример: custom_fields[field_id] = value, в случае иерархического поля, необходимо указывать уровень custom_fields[field_id][level] = value, массив (необязательный)
);

//Вывод данных запроса
print_r($start->TicketUpdate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

TicketDelete($options) - Удаление заявки по ticket_id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'id'      => 1,// ID заявки, число (обязательный)
    'delete'  => true,// false - перенос заявки в удаленные. true - полное удаление заявки. По умолчанию значение false, булево (необязательный)
);

//Вывод данных запроса
print_r($start->TicketDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        
 

TicketAnswersGet($options) - Получение списка ответов по ticket_id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'ticket_id'      => 1, // ID заявки, число (обязательный)
    'page'      => 1, // Номер страницы, число (необязательный)
);

//Вывод данных запроса
print_r($start->TicketAnswersGet($options));
                                            
                                        
@return
  • application/json

                                            
{
    "data":[
        {
            "ticket_id":9,
            "id":139,
            "user_id":1,
            "text":"post content",
            "date_created":"17:45:00 26.01.2017",
            "date_updated":"17:45:00 26.01.2017",
            "files":[]
        },{
            "ticket_id":9,
            "id":138,
            "user_id":1,
            "text":"1,2,3",
            "date_created":"14:59:00 17.01.2017",
            "date_updated":"14:59:00 17.01.2017",
            "files":[
                {
                    "name":"test.gif",
                    "url":"https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
                    "data_type":"gif"
                },{
                    "name":"test.png",
                    "url":"https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
                    "data_type":"png"
                }
            ]
        },
    ],
    "pagination":{
                "total":85,
                "per_page":30,
                "current_page":1,
                "total_pages":3
    }
}
                                            
                                        
 

TicketAnswerSet($options) - Создание ответа заявки по ticket_id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'ticket_id'      => 1, // ID заявки, число (обязательный)
    'text'      => 'Problem with email', // Текст комментария, строка (обязательный)
    'user_id'      => 1, // Владелец комментария, в случае если не будет указан - владельцем будет пользователь API, число (необязательный)
    'files'      => [], // Массив приложений, массив файлов (необязательный)
);

//Вывод данных запроса
print_r($start->TicketAnswerSet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "ticket_id": 9,
    "id": 150,
    "user_id": 1,
    "text": "Problem with email",
    "date_created": "17:02:00 17.01.2017",
    "date_updated": "17:02:00 17.01.2017",
    "files": [
      {
        "name": "test.gif",
        "url": "https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
        "data_type": "gif"
      },
      {
        "name": "test.png",
        "url": "https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
        "data_type": "png"
      }
    ]
  }
}
                                            
                                        

TicketAnswerUpdate($options) - Редактирование ответа по ticket_id и answer id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'ticket_id'      => 1, // ID заявки, число (обязательный)
    'id'      => 15, // ID поста, число (обязательный)
    'text'      => 'Problem with email', // Текст комментария, строка (обязательный)
);

//Вывод данных запроса
print_r($start->TicketAnswerUpdate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "ticket_id": 9,
    "id": 150,
    "user_id": 1,
    "text": "Problem with email",
    "date_created": "17:02:00 17.01.2017",
    "date_updated": "17:02:00 17.01.2017",
    "files": [
      {
        "name": "test.gif",
        "url": "https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
        "data_type": "gif"
      },
      {
        "name": "test.png",
        "url": "https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
        "data_type": "png"
      }
    ]
  }
}
                                            
                                        

TicketAnswerDelete($options) - Удаление ответа по ticket_id и answer id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'ticket_id'      => 1, // ID заявки, число (обязательный)
    'id'      => 15 // ID поста, число (обязательный)
);

//Вывод данных запроса
print_r($start->TicketAnswerDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "errors": [
    {
      "code": "s-204",
      "title": "No content",
      "details": "Post with id {15} in ticket with id {9} successfully deleted"
    }
  ]
}
                                            
                                        
 

TicketStatusesListGet() - Получение списка статусов заявок

@params
  •  
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Вывод данных запроса
print_r($start->TicketStatusesListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": "open",
      "name": {
        "ru": "Открыто",
        "en": "Open",
        "ua": "Открыто"
      }
    },
    {
      "id": "process",
      "name": {
        "ru": "В процессе",
        "en": "In progress",
        "ua": "В процессе"
      }
    },
    {
      "id": "closed",
      "name": {
        "ru": "Выполнено",
        "en": "Closed",
        "ua": "Выполнено"
      }
    }
  ]
}
                                            
                                        

TicketPrioritiesListGet() - Получение списка приоритетов заявок

@params
  •  
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');


//Вывод данных запроса
print_r($start->TicketPrioritiesListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 2,
      "name": {
        "ru": "Стандартно",
        "en": "Standard",
        "ua": "Стандартно"
      }
    },
    {
      "id": 3,
      "name": {
        "ru": "Средний",
        "en": "Medium",
        "ua": "Средний"
      }
    },
    {
      "id": 1,
      "name": {
        "ru": "Срочно",
        "en": "Very urgent",
        "ua": "Срочно"
      }
    }
  ]
}
                                            
                                        

TicketTypesListGet() - Получения списка типов заявки

                                        
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Вывод данных запроса
print_r($start->TicketTypesListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 0,
      "name": {
        "ru": "Без типа",
        "en": "Without type",
        "ua": "Без типа"
      }
    },
    {
      "id": 1,
      "name": {
        "ru": "Проблема",
        "en": "Problem",
        "ua": "Проблема"
      }
    },
    {
      "id": 2,
      "name": {
        "ru": "Задание",
        "en": "Task",
        "ua": "Задание"
      }
    },
    {
      "id": 3,
      "name": {
        "ru": "Ошибка",
        "en": "Bug",
        "ua": "Ошибка"
      }
    }
  ]
}
                                            
                                        

CustomFieldsListGet() - Получение списка кастомных полей

@params
  •  
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');


//Вывод данных запроса
print_r($start->CustomFieldsListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "2": {
      "id": 2,
      "name": {
        "ru": "Select",
        "en": "Select",
        "ua": "Select"
      },
      "field_type": "select",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        }
      }
    },
    "3": {
      "id": 3,
      "name": {
        "ru": "Date",
        "en": "Date",
        "ua": "Date"
      },
      "field_type": "date",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        }
      }
    },
    "4": {
      "id": 4,
      "name": {
        "ru": "Checkbox",
        "ua": "Checkbox"
      },
      "field_type": "checkbox",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        }
      }
    },
    "5": {
      "id": 5,
      "name": {
        "ru": "Text",
        "en": "Text",
        "ua": "Text"
      },
      "field_type": "text",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": true,
          "required_to_close_ticket": true
        }
      }
    },
    "6": {
      "id": 6,
      "name": {
        "ru": "Textarea",
        "en": "Textarea",
        "ua": "Textarea"
      },
      "field_type": "textarea",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        }
      }
    },
    "7": {
      "id": 7,
      "name": {
        "ru": "Number",
        "en": "Number",
        "ua": "Number"
      },
      "field_type": "number",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": false
        }
      }
    },
    "8": {
      "id": 8,
      "name": {
        "1": {
          "ru": "Related",
          "en": "Related",
          "ua": "Related"
        },
        "2": {
          "ru": "Related 2",
          "en": "Related 2",
          "ua": "Related 2"
        },
        "3": {
          "ru": "Related 3",
          "en": "Related 3",
          "ua": "Related 3"
        },
        "4": {
          "ru": "Related 4",
          "en": "Related 4",
          "ua": "Related 4"
        }
      },
      "field_type": "hierarchy",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": true,
          "required_to_close_ticket": false
        }
      }
    }
  },
  "pagination": {
    "total": 7,
    "per_page": 30,
    "current_page": 1,
    "total_pages": 1
  }
}
                                            
                                        

CustomFieldGet($options) - Получение кастомного поля

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'id'      => 15 // ID поля, число (обязательный)
);

//Вывод данных запроса
print_r($start->CustomFieldGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "2": {
      "id": 2,
      "name": {
        "ru": "Select",
        "en": "Select",
        "ua": "Select"
      },
      "field_type": "select",
      "permissions": {
        "staff": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        },
        "user": {
          "view": true,
          "edit": true,
          "required_to_create_ticket": false,
          "required_to_close_ticket": true
        }
      }
    }
  }
}
                                            
                                        
 

OptionsGet($options) - Получение кастомной опции

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'custom_field_id'      => 1, // ID поля, число (обязательный)
);

//Вывод данных запроса
print_r($start->OptionsGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 5,
      "pid": 0,
      "name": {
        "ru": "1",
        "en": "1",
        "ua": "1"
      }
    },
    {
      "id": 6,
      "pid": 0,
      "name": {
        "ru": "2",
        "en": "2",
        "ua": "2"
      }
    },
    {
      "id": 7,
      "pid": 0,
      "name": {
        "ru": "3",
        "en": "3",
        "ua": "3"
      }
    },
    {
      "id": 171,
      "pid": 0,
      "name": {
        "ru": "4",
        "en": "4",
        "ua": "4"
      }
    }
  ],
  "pagination": {
    "total": 4,
    "per_page": 50,
    "current_page": 1,
    "total_pages": 1
  }
}
                                            
                                        

OptionsSet($options) - Редактирование опции кастомного поля

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'custom_field_id'      => 1, // ID поля, число (обязательный)
    'options'      => {"options":[{"id": "20", "name":{"ru":"update option","en":"update option","ua":"update option"}}]} // Добавить/обновить опции, массив (обязательный)
);

//Вывод данных запроса
print_r($start->OptionsSet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 20,
      "pid": 0,
      "name": {
        "ru": "update option",
        "en": "update option",
        "ua": "update option"
      }
    },
    {
      "id": 233,
      "pid": 0,
      "name": {
        "ru": "new option",
        "en": "new option",
        "ua": "new option"
      }
    },
    {
      "id": 234,
      "pid": 21,
      "name": {
        "ru": "new option",
        "en": "new option",
        "ua": "new option"
      }
    }
  ]
}
                                            
                                        

OptionsDelete($options) - Удаление опции кастомного поля по custom_field_id и option_id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'custom_field_id'      => 1, // ID поля, число (обязательный)
    'option_id'      => 233 // ID опции, число (обязательный)
);

//Вывод данных запроса
print_r($start->OptionsDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "errors": [
    {
      "code": "s-204",
      "title": "No content",
      "details": "Option with id {233} successfully deleted"
    }
  ]
}
                                            
                                        

Коментарии

CommentsGet($options) - Получение списка коментариев по ticket_id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'ticket_id'      => 1,// ID заявки, число (обязательный)
    'page'      => 1// Номер страницы, число (необязательный)
);

//Вывод данных запроса
print_r($start->CommentsGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 9,
    "unique_id": "IQV-84397",
    "date_created": "2016-08-15 17:05:19",
    "date_updated": "2017-01-18 11:44:13",
    "title": "Test ticket",
    "source": "email",
    "status_id": "process",
    "priority_id": 3,
    "type_id": 1,
    "department_id": 2,
    "department_name": "Отдел поддержки",
    "owner_id": 1,
    "owner_name": "Ivan",
    "owner_lastname": "Petrov",
    "owner_email": "ivan.petrov@example.com",
    "user_id": 41,
    "user_name": "John",
    "user_lastname": "Doe",
    "user_email": "john.doe@example.com",
    "cc": [],
    "bcc": [],
    "followers": [],
    "ticket_lock": 0,
    "sla_date": "17.01.2017 16:00",
    "freeze_date": "null",
    "freeze": 0,
    "deleted": 0,
    "viewed_by_staff": 1,
    "viewed_by_client": 1,
    "rate": "",
    "rate_comment": "",
    "rate_date": "",
    "custom_fields": [
      {
        "id": 3,
        "field_type": "textarea",
        "field_value": "4345"
      },
      {
        "id": 4,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

CommentCreate($options) - Новый коментарий заявки по ticket_id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'ticket_id'      => 1, // ID заявки, число (обязательный)
    'text'      => 'Problem with email', // Текст комментария, строка (обязательный)
    'user_id'      => 1, // Владелец комментария, в случае если не будет указан - владельцем будет пользователь API, число (необязательный)
    'files'      => [], // Массив приложений, массив файлов (необязательный)
);

//Вывод данных запроса
print_r($start->CommentCreate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "ticket_id": 9,
    "id": 6,
    "user_id": 1,
    "text": "test",
    "date_created": "18:18:34 05.01.2017",
    "visible": "staff",
    "files": [
      {
        "name": "test.gif",
        "url": "https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
        "data_type": "gif"
      },
      {
        "name": "test.png",
        "url": "https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
        "data_type": "png"
      }
    ]
  }
}
                                            
                                        

CommentUpdate($options) - Редактирование коментария по ticket_id и comment id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'ticket_id'      => 1, // ID заявки, число (обязательный)
    'id'      => 15, // ID комментария, число (обязательный)
    'text'      => 'Problem with email', // Текст комментария, строка (обязательный)
);

//Вывод данных запроса
print_r($start->CommentUpdate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "ticket_id": 9,
    "id": 6,
    "user_id": 1,
    "text": "Problem with email",
    "date_created": "18:18:34 05.01.2017",
    "visible": "staff",
    "files": [
      {
        "name": "test.gif",
        "url": "https://домен_системы/ru/file/download/f8bb43e593d867d27c965d38dfec721fbb084cf9",
        "data_type": "gif"
      },
      {
        "name": "test.png",
        "url": "https://домен_системы/ru/file/download/b818daf594dd3b61098cce7fef7954bc0314edd5",
        "data_type": "png"
      }
    ]
  }
}
                                            
                                        

CommentDelete($options) - Удаление коментария по ticket_id и comment id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'ticket_id'      => 1, // ID заявки, число (обязательный)
    'id'      => 15 // ID комментария, число (обязательный)
);

//Вывод данных запроса
print_r($start->CommentDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "errors": [
    {
      "code": "s-204",
      "title": "No content",
      "details": "Comment with id {15} in ticket with id {9} successfully deleted"
    }
  ]
}
                                            
                                        

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

UserListGet($options) - Получение списка пользователей

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'page'      => 1,// Номер страницы, число (необязательный)
    'search'      => 'John Doe',// Поиск по пользователям, строка (необязательный)
    'group_list'      => 1,// Поиск пользователей по ID группы, число (необязательный)
    'from_date_created'      => '2018-12-31 00:00:00',// Дата создания от, строка (необязательный)
    'to_date_created'      => '2018-12-31 00:00:00',// Дата создания до, строка (необязательный)
    'from_date_updated'      => '2018-12-31 00:00:00',//Дата изменения от, строка (необязательный)
    'to_date_updated'      => '2018-12-31 00:00:00',// Дата изменения до, строка (необязательный)
    'order_by'      => 'name'// Сортировка пользователей, можно указать через запятую. Пользователей можно сортировать по параметрам: date_created, date_updated, name. Порядок сортировки {asc} (по возрастанию) и {desc} (по убыванию), строка (необязательный)
);

print_r($start->UserListGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": [
    {
      "id": 1,
      "date_created": "2019-01-01 00:00:00",
      "date_updated": "2019-01-01 00:00:00",
      "name": "Admin",
      "lastname": "",
      "email": "test@helpdeskeddy.com",
      "phone": "+37129770143",
      "skype": "",
      "website": "",
      "organization": "",
      "status": "active",
      "language": "en",
      "notifications": 0,
      "api_key": "a32858b4-a65e-49ef-a960-0b7e8d5d1e47",
      "group": {
        "id": 2,
        "type": "staff",
        "name": {
          "ru": "Администратор",
          "en": "Administrator",
          "ua": ""
        },
        "disable": 0
      },
      "department": [
        1,
        2
      ],
      "ldap_username": "",
      "custom_fields": [
        {
          "id": 87,
          "field_type": "textarea",
          "field_value": "test"
        },
        {
          "id": 88,
          "field_type": "checkbox",
          "field_value": 1
        }
      ]
    },
    {
      "id": 6,
      "date_created": "2019-01-01 00:00:00",
      "date_updated": "2019-01-01 00:00:00",
      "name": "Test",
      "lastname": "",
      "email": "test@test.lv",
      "phone": "",
      "skype": "",
      "website": "",
      "organization": "",
      "status": "active",
      "language": "en",
      "notifications": 0,
      "api_key": "a43e6bdc-2ff9-483b-8ebf-ea3ade763864",
      "group": {
        "id": 1,
        "type": "user",
        "name": {
          "ru": "Клиент",
          "en": "Client",
          "ua": "Клиент"
        },
        "disable": 0
      },
      "department": [
        1,
        2
      ],
      "ldap_username": "",
      "custom_fields": [
        {
          "id": 87,
          "field_type": "textarea",
          "field_value": "test"
        },
        {
          "id": 88,
          "field_type": "checkbox",
          "field_value": 1
        }
      ]
    }
  ],
  "pagination": {
    "total": 2,
    "per_page": 30,
    "current_page": 1,
    "total_pages": 1
  }
}
                                            
                                        

UserGet($options) - Получение пользователя по id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'id'      => 1 // ID пользователя, число (обязательный)
);

//Вывод данных запроса
print_r($start->UserGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 1,
    "date_created": "2019-01-01 00:00:00",
    "date_updated": "2019-01-01 00:00:00",
    "name": "Admin",
    "lastname": "",
    "email": "test@helpdeskeddy.com",
    "phone": "+37129770143",
    "skype": "",
    "website": "",
    "organization": "",
    "status": "active",
    "language": "en",
    "notifications": 0,
    "api_key": "a32858b4-a65e-49ef-a960-0b7e8d5d1e47",
    "group": {
      "id": 2,
      "type": "staff",
      "name": {
        "ru": "Администратор",
        "en": "Administrator",
        "ua": "Администратор"
      },
      "disable": 0
    },
    "department": [
      1,
      2
    ],
    "ldap_username": "",
    "custom_fields": [
      {
        "id": 87,
        "field_type": "textarea",
        "field_value": "test"
      },
      {
        "id": 88,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}                                   
                                        

UserCreate($options) - Новый пользователь

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'name'      => 'John', // Имя, строка (обязательный)
    'lastname      => 'Doe', // Фамилия, строка (необязательный)
    'email'      => 'info@example.com', // Почта, строка (обязательный)
    'phone      => '37192345678', // Телефон, строка (необязательный)
    'skype'      => '', // Скайп, строка (необязательный)
    'website'      => 'http://example.com', // Вебсайт, строка (необязательный)
    'organization'      => 'organization', // Организация. Название новой организации. Если заполнено — поле organiz_id не учитывается, строка (необязательный)
    'organiz_id'      => '', // ID существующей организации, число (необязательный)
    'status'      => 'test user', //Статус пользователя. Доступные статусы: active, inactive, disabled, fired, строка (необязательный)
    'language'      => 'en', // Язык пользователя. Доступны все активные языки в системе, строка (необязательный)
    'notifications'      => 1, // Уведомления на почту. 0 - отключены. Доступные значения 1 и 0, число (необязательный)
    'group_id      => 15, // ID группы, число (обязательный)
    'department'      => [0 => 1, 1 => 2], //Департаменты пользователя, массив (обязательный)
    'password      => '123456', // Пароль, строка (обязательный)
    'custom_fields'      => [87 => 'test', 2 => 1] //Массив индивидуальных полей контактов, пример: custom_fields[field_id] = value, в случае иерархического поля, необходимо указывать уровень custom_fields[field_id][level] = value, массив (необязательный)
);

//Вывод данных запроса
print_r($start->UserCreate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 22,
    "date_created": "2019-01-01 00:00:00",
    "date_updated": "2019-01-01 00:00:00",
    "name": "John",
    "lastname": "Doe",
    "email": "info@example.com",
    "phone": "37192345678",
    "skype": "",
    "website": "http://example.com",
    "organization": {
      "id": 8,
      "name": "Organization",
      "domains": "",
      "address": "",
      "phone": "37192345678",
      "email": "info@example.com",
      "web": "http://example.com"
    },
    "status": "active",
    "language": "en",
    "notifications": 0,
    "api_key": "cf780f93-8bd4-460d-8a56-1f6adadb8e46",
    "group": {
      "id": 1,
      "type": "user",
      "name": {
        "ru": "Клиент",
        "en": "Client",
        "ua": "Клиент"
      },
      "disable": 0
    },
    "department": [
      1,
      2
    ],
    "ldap_username": "",
    "custom_fields": [
      {
        "id": 87,
        "field_type": "textarea",
        "field_value": "test"
      },
      {
        "id": 88,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

UserUpdate($options) - Редактирование пользователя по id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'id'      => 22, // ID пользователя, число (обязательный
    'name'      => 'John', // Имя, строка (необязательный)
    'lastname      => 'Doe', // Фамилия, строка (необязательный)
    'email'      => 'info@example.com', // Почта, строка (необязательный)
    'phone      => '37192345678', // Телефон, строка (необязательный)
    'skype'      => '', // Скайп, строка (необязательный)
    'website'      => 'http://example.com', // Вебсайт, строка (необязательный)
    'organization'      => 'organization', // Организация. Название новой организации. Если заполнено — поле organiz_id не учитывается, строка (необязательный)
    'organiz_id'      => '', // ID существующей организации, число (необязательный)
    'status'      => 'test user', //Статус пользователя. Доступные статусы: active, inactive, disabled, fired, строка (необязательный)
    'language'      => 'en', // Язык пользователя. Доступны все активные языки в системе, строка (необязательный)
    'notifications'      => 1, // Уведомления на почту. 0 - отключены. Доступные значения 1 и 0, число (необязательный)
    'group_id      => 15, // ID группы, число (необязательный)
    'department'      => [0 => 1, 1 => 2], //Департаменты пользователя, массив (необязательный)
    'password      => '123456', // Пароль, строка (необязательный)
    'custom_fields'      => [87 => 'test', 2 => 1] //Массив индивидуальных полей контактов, пример: custom_fields[field_id] = value, в случае иерархического поля, необходимо указывать уровень custom_fields[field_id][level] = value, массив (необязательный)
);

//Вывод данных запроса
print_r($start->UserUpdate($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "id": 22,
    "date_created": "2019-01-01 00:00:00",
    "date_updated": "2019-01-01 00:00:00",
    "name": "John",
    "lastname": "Doe",
    "email": "info@example.com",
    "phone": "37192345678",
    "skype": "",
    "website": "http://example.com",
    "organization": {
      "id": 8,
      "name": "Organization",
      "domains": "",
      "address": "",
      "phone": "37192345678",
      "email": "info@example.com",
      "web": "http://example.com"
    },
    "status": "active",
    "language": "en",
    "notifications": 0,
    "api_key": "cf780f93-8bd4-460d-8a56-1f6adadb8e46",
    "group": {
      "id": 1,
      "type": "user",
      "name": {
        "ru": "Клиент",
        "en": "Client",
        "ua": "Клиент"
      },
      "disable": 0
    },
    "department": [
      1,
      2
    ],
    "ldap_username": "",
    "custom_fields": [
      {
        "id": 87,
        "field_type": "textarea",
        "field_value": "test"
      },
      {
        "id": 88,
        "field_type": "checkbox",
        "field_value": 1
      }
    ]
  }
}
                                            
                                        

UserDelete($options) - Удаление пользователя по id

@params
  • $options - массив опций
                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'id'      => 15 // ID пользователя, число (обязательный)
);

//Вывод данных запроса
print_r($start->UserDelete($options));
                                            
                                        
@return
  • application/json

                                            
{
  "errors": [
    {
      "code": "s-204",
      "title": "No content",
      "details": "User with id {22} successfully deleted"
    }
  ]
}
                                            
                                        

База знаний

CategoriesListGet($options) - Получение списка категорий базы знаний

@params
  • $options - массив опций

                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'page'      => 1,// Номер страницы, число (необязательный)
    'public'      => false,// Поиск по публичным категориям, булево (необязательный)
    'parent_list'      => '1,2,3',// Поиск категорий по родительским категориям, через запятую, строка (необязательный)
    'from_date_created'      => '2018-12-31 00:00:00',// Дата создания от, строка (необязательный)
    'to_date_created'      => '2018-12-31 00:00:00',// Дата создания до, строка (необязательный)
    'from_date_updated'      => '2018-12-31 00:00:00',//Дата изменения от, строка (необязательный)
    'to_date_updated'      => '2018-12-31 00:00:00',// Дата изменения до, строка (необязательный)
    'order_by'      => 'position'// Сортировка категорий, можно указать через запятую. Категории можно сортировать по параметрам: date_created, date_updated, position. Порядок сортировки {asc} (по возрастанию) и {desc} (по убыванию). Значение по умолчанию: position{asc}, строка (необязательный)
);

//Вывод данных запроса
print_r($start->CategoriesListGet());
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "1": {
      "id": 1,
      "parent_id": 0,
      "position": 23,
      "date_created": "2017-03-24 15:47:01",
      "date_updated": "2019-03-05 20:19:40",
      "access": "staff",
      "access_by_groups": [
        1,
        3,
        2
      ],
      "title": {
        "ru": "test category 1",
        "en": "test category 1",
        "ua": "test category 1"
      }
    },
    "2": {
      "id": 2,
      "parent_id": 1,
      "position": 21,
      "date_created": "2017-05-29 11:57:24",
      "date_updated": "2018-12-06 15:25:57",
      "access": "user",
      "access_by_groups": [
        3,
        5,
        6,
        7,
        8,
        10,
        11,
        2
      ],
      "title": {
        "ru": "test category 2",
        "en": "test category 2",
        "ua": "test category 2"
      }
    },
    "-1": {
      "id": -1,
      "parent_id": 0,
      "position": 1,
      "date_created": "2015-12-31 23:00:00",
      "date_updated": "2019-01-30 15:54:21",
      "access": "public",
      "access_by_groups": [
        1,
        3,
        2
      ],
      "title": {
        "ru": "Шаблоны",
        "en": "Templates",
        "ua": "Шаблони"
      }
    },
    "-2": {
      "id": -2,
      "parent_id": 0,
      "position": 3,
      "date_created": "2018-01-01 00:00:00",
      "date_updated": "2019-03-16 01:06:45",
      "access": "user",
      "access_by_groups": [
        1,
        3,
        2
      ],
      "title": {
        "ru": "Новости",
        "en": "News",
        "ua": "Новини"
      }
    }
  },
  "pagination": {
    "total": 4,
    "per_page": 30,
    "current_page": 1,
    "total_pages": 1
  }
}                                        
                                        

ArticlesListGet($options) - Получение списка статей

@params
  • $options - массив опций

                                            
//Инициализация
$start = new HDESDKSDKInit();

//Авторизация пользователя
$start->Auth('example@example.com', 'your-api-key', 'https://example.helpdeskeddy.com');

//Задание опций
$options = array(
    'page'      => 1,// Номер страницы, число (необязательный)
    'public'      => false,// Поиск по публичным статьям, булево (необязательный)
    'category_list'      => '1,2,3',// Поиск статей по категориям, через запятую, строка (необязательный)
    'from_date_created'      => '2018-12-31 00:00:00',// Дата создания от, строка (необязательный)
    'to_date_created'      => '2018-12-31 00:00:00',// Дата создания до, строка (необязательный)
    'from_date_updated'      => '2018-12-31 00:00:00',//Дата изменения от, строка (необязательный)
    'to_date_updated'      => '2018-12-31 00:00:00',// Дата изменения до, строка (необязательный)
    'order_by'      => 'views'// Сортировка статей, можно указать через запятую. Статьи можно сортировать по параметрам: date_created, date_updated, views, pin. Порядок сортировки {asc} (по возрастанию) и {desc} (по убыванию). Значение по умолчанию: date_created{desc}, строка (необязательный)
);

//Вывод данных запроса
print_r($start->ArticlesListGet($options));
                                            
                                        
@return
  • application/json

                                            
{
  "data": {
    "56": {
      "id": 56,
      "date_created": "2018-07-17 15:15:00",
      "date_updated": "2018-07-24 17:12:55",
      "show_me_only": false,
      "access": "public",
      "pin": false,
      "views_count": 130,
      "categories": [
        1
      ],
      "title": {
        "ru": "test article",
        "en": "test article",
        "ua": "test article"
      },
      "tags": {
        "ru": [
          "test",
          "test2",
          "test3"
        ],
        "en": [],
        "ua": []
      },
      "body": {
        "ru": "test body",
        "en": "test body",
        "ua": "test body"
      },
      "files": []
    },
    "57": {
      "id": 57,
      "date_created": "2018-07-17 15:15:00",
      "date_updated": "2018-07-24 17:27:27",
      "show_me_only": false,
      "access": "staff",
      "pin": false,
      "views_count": 43,
      "categories": [
        1,
        2
      ],
      "title": {
        "ru": "test article",
        "en": "test article",
        "ua": "test article"
      },
      "tags": {
        "ru": [
          "режим",
          "серия pro"
        ],
        "en": [],
        "ua": []
      },
      "body": {
        "ru": "test body",
        "en": "test body",
        "ua": "test body"
      },
      "files": []
    },
    "58": {
      "id": 58,
      "date_created": "2018-07-17 15:15:00",
      "date_updated": "2018-07-17 15:15:00",
      "show_me_only": false,
      "access": "user",
      "pin": false,
      "views_count": 3,
      "categories": [
        2
      ],
      "title": {
        "ru": "test article",
        "en": "test article",
        "ua": "test article"
      },
      "tags": {
        "ru": [
          "ретранслятор",
          "ретрансляция",
          "ртр",
          "ри-м",
          "рр"
        ],
        "en": [],
        "ua": []
      },
      "body": {
        "ru": "test body",
        "en": "test body",
        "ua": "test body"
      },
      "files": []
    },
    "60": {
      "id": 60,
      "date_created": "2018-07-24 17:24:00",
      "date_updated": "2019-02-01 18:04:21",
      "show_me_only": false,
      "access": "public",
      "pin": false,
      "views_count": 32,
      "categories": [
        -2,
        2
      ],
      "title": {
        "ru": "test article",
        "en": "test article",
        "ua": "test article"
      },
      "tags": {
        "ru": [],
        "en": [],
        "ua": []
      },
      "body": {
        "ru": "test body",
        "en": "test body",
        "ua": "test body"
      },
      "files": [
        {
          "name": "test.gif",
          "url": "https://домен_системы/ru/knowledge_base/download/60/file/f8bb43e593d867d27c965d38dfec721fbb084cf9",
          "data_type": "gif"
        },
        {
          "name": "test.png",
          "url": "https://домен_системы/ru/knowledge_base/download/60/file/b818daf594dd3b61098cce7fef7954bc0314edd5",
          "data_type": "png"
        }
      ]
    }
  },
  "pagination": {
    "total": 4,
    "per_page": 10,
    "current_page": 1,
    "total_pages": 1
  }
}