shami/yougile

YouGile REST API

1.0.2 2023-03-17 19:51 UTC

Requires

• php: >=5.4
• ext-json: *
• guzzlehttp/guzzle: ^7.0

MIT

• Shamil Shafeev

README

Библиотека для работы с YouGile REST API v2.0

Описание и примеры: shafeev.net

Установка

Через Composer

composer require shami/yougile

Использование

Инициализация

require_once __DIR__ . "/vendor/autoload.php";

use Yougile\Yougile;

$yougile = new Yougile('ID_Компании', 'КЛЮЧ');

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

1. Получить ID компании
2. Получить ключ API

Общая информация

Чтобы воспользоваться определенным методом, необходимо указать ресурс к которому данный метод относится.

$resources = $yougile->api('resources');

Далее можно обращаться к любому методу из указанного ресурса.

$result = $resources->create();

Примеры

Получить список сотрудников

$users = $yougile->api("users");
$user_list = $users->get_list();
var_dump($user_list);

Пригласить в компанию сотрудника

$users = $yougile->api("users");
$res = $users->create("[e-mail]", true); // два параметра: $email, $isAdmin - имеет ли пользователь права администратора
var_dump($res);

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

$users = $yougile->api("users");
$user = $users->get_by_id("ТУТ_ID");
var_dump($user);

Удалить из компании

$users = $yougile->api("users");
$res = $users->delete("ТУТ_ID");
var_dump($res);

Доступные ресурсы

• Users
• Tasks
• Boards
• Chats
• Columns
• Departments
• GroupChats
• Projects
• Roles
• SprintStickers
• StringStickers