Skip to content

sh-sham/yougile-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

yougile-api

Библиотека для работы с 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("info@shafeev.net", 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