xnekv03/freelo-api-client

Freelo API包装器

v1.0.0 2020-02-08 13:13 UTC

This package is auto-updated.

Last update: 2024-09-29 05:29:05 UTC


README

此库使发送请求到Freelo API变得简单

安装

推荐通过Composer安装包。

# Install Composer
curl -sS https://getcomposer.org/installer | php

接下来,运行Composer命令以安装最新稳定版本的包

composer require xnekv03/freelo-api-client

安装后,您需要引入Composer的自动加载器

require 'vendor/autoload.php';

然后您可以稍后使用Composer更新包

composer update

使用方法

开始之前

创建Freelo账号

注册

获取API密钥

登录到您的仪表板,转到设置并获取API密钥,它可能类似于9lDZU35Lb0wmnq4tWvmmUkugLja4dXwPDcOMP1CBdIa

初始化API客户端

# load autoload file
require_once  'vendor/autoload.php';

# Import Freelo library
use Freelo\Client;

$freeloApiToken = '9lDZU35Lb0wmnq4tWvmmUkugLja4dXwPDcOMP1CBdIa';
$loginEmail = 'john@doe.com';

# Initialize a client
$freeloClient = new Client($freeloApiToken,$loginEmail);

创建项目

$projectName = "Project Alice";
$currencyIso = "EUR";  // currently EUR, USD or CZK is supported

$projectId = $freeloClient->createProject($projectName, $currencyIso);
echo $projectId;        // 74201 - project ID is returned

包含所有自己的项目以及活动的待办事项列表的集合

$projects = $freeloClient->getAllOwnProjectIncludinglToDo();
var_dump($projects);        // array with all projects including their names, IDs and task lists

所有受邀项目的分页集合

$projects = $freeloClient->getAllInvitedProjects();
var_dump($projects);        // array with all invited projects

所有存档项目的分页集合

$projects = $freeloClient->getAllArchivededProjects();
var_dump($projects);        // array with all archived projects

所有模板项目的分页集合

$projects = $freeloClient->getAllTemplateProjects();
var_dump($projects);        // array with all templated projects

项目成员集合

$projectId = 73335;
$projectsWorkers = $freeloClient->allProjectWorkers($projectId);
var_dump($projectsWorkers);        // array with all workers assigned to given project

创建待办事项列表

$projectId = 73335;     // ID of an existing project
$budget = 10205; // 2 decimal places with no decimal separator, ie. 1.05 = '105'
$listName = 'Pre-launch test';

$projectDetails = $freeloClient->createToDoList($projectId, $budget, $listName);
var_dump($projectDetails);        // array with task details

查找所有可分配给待办事项列表的成员

$projectId = 73335;     // ID of an existing project
$taskId = 179444;     // ID of existing task

$workers = $freeloClient->assignableWorkersCollection($projectId, $taskId);
var_dump($workers);        // array with available workers and their IDs