Обертка для YouGile REST API

Официальная документация API: на сайте yougile
Обертка для API: на github

Необходимые данные

Для начала работы с api обязательно нужно знать два параметра: ID компании и ключ.
Получить их можно с помощью методов:

Альтернативные варианты получения ID компании (подсказали в технической поддержке сервиса)

С помощью сочетания клавиш ctrl + alt +q.
На экране появится id и автоматически скопируется в буфер обмена.

Еще ID компании можно увидеть в конфигураторе компании, в навигаторе по объектам

Установка

Установка библиотеки происходит при помощи Composer.
Если Composer еще не установлен это можно сделать по инструкции на getcomposer.org, или одним из нижеперечисленных способов.
На Linux или Mac используйте следующую команду:

curl -sS https://getcomposer.org/installer | php
mv composer.phar /usr/local/bin/composer

На Windows, скачайте и запустите Composer-Setup.exe.

Далее можно приступать к установке самой библиотеки-обертки, для этого нужно ввести команду

composer require shami/yougile

в результате ввода команды увидим

и в директории будет создана папка vendor

Готово! Библиотека установлена и готова к работе.

Пример работы

Для простоты и наглядности в той же папке куда мы устанавливали библиотеку создадим файл main.php.
Содержимое файла:

require_once __DIR__ . "/vendor/autoload.php"; // подключение 

use Yougile\Yougile;

$yougile = new Yougile('ID_Компании', 'КЛЮЧ'); // вводим свои значения

Далее с помощью переменной $yougile мы можем обращаться к различным разделам YouGile REST API.

Раздел задачи

Получить список задач

$tasks = $yougile->api("tasks")->get_list(); // получить список задач
echo '<pre>';
var_dump($tasks); // вывод результата

Получить информацию о конкретной задаче по ее ID

    $task = $yougile->api("tasks")->get_by_id("07824884-a8c1-4a48-a490-000000000000"); // Получить информацию о конкретной задаче по ее ID
    echo '<pre>';
    var_dump($task);

Создание задачи

    ## Список параметров: https://ru.yougile.com/api-v2#/operations/TaskController_create
    $params = array(
        "title" => "Hello!", // Обязательный
        "columnId" => "9a209afc-dab5-4856-84c2-000000000",
        "description" => "Test"
    );
    $task = $yougile->api("tasks")->create($params);

Обновление задачи

    $id_task = "2a3a009c-a312-4087-a80b-000000000"; // id задачи
    $params = array(
        "title" => "Hello New!", // Обязательный
    );
    $task = $yougile->api("tasks")->update($id_task, $params);
Подписаться
Уведомить о
guest
2 комментариев
Старые
Новые Популярные
Межтекстовые Отзывы
Посмотреть все комментарии