shami/yougile

YouGile REST API

1.0.2 2023-03-17 19:51 UTC

This package is auto-updated.

Last update: 2024-09-18 11:49:19 UTC


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("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);

可用资源

  • 用户
  • 任务
  • 看板
  • 聊天
  • 部门
  • 群聊
  • 项目
  • 角色
  • 冲刺贴纸
  • 字符串贴纸