API: методы и документация

Для взаимодействия сторонних приложений с HelpDeskEddy разработан API (интерфейс прикладного программирования) (англ. application programming interface, API). При помощи набора функций существует возможность работать как с пользователями Вашей системы, так и с заявками.

Чтобы начать работу с приложением API, перейдите через "Управление" в раздел "Глобальные настройки", где Вы в подразделе "Система" найдёте API ключ. Данный ключ используется как основной метод авторизации в системе (при помощи API). При необходимости Вы можете сгенерировать новый ключ.

 

 

Вся документация представлена по ссылке.

 

Доступные методы:                    

Детальнее ознакомиться с примерами отправки запросов можно в этом ролике:

 

 

Пример метода "Получить заявки" с помощью GuzzleHttp:

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://domain.helpdeskeddy.com/',
]);

try {
    $response = $client->get('api/v2/tickets/',
        [
            'auth'      => [
                'example@example.com',
                'api-key',
            ],
        ]);

    print_r(json_decode($response->getBody()->getContents(), true));
} catch (GuzzleHttp\Exception\ClientException $e) {
    $response = $e->getResponse();
    print_r($response->getBody()->getContents());
}
?>
© 2024, HelpDeskEddy