ontimetools/api-sdk

Axosoft的OnTime API SDK

dev-master 2015-02-23 19:29 UTC

This package is not auto-updated.

Last update: 2024-09-28 15:57:25 UTC


README

#OnTimeTools Api SDK

Build Status

OTTAS是一个简单的PHP库,允许您轻松请求Axosoft的OnTime API。

"require": {
    "ontimetools/api-sdk": "v1.0.*"
}

要使用它,您只需按照以下简单步骤进行####1- 创建一个 'ConnectionRequest' 对象

use OTT\Api\Connection\ConnectionRequest;
$request = new ConnectionRequest();
$request->setOntimeUrl('https://mysubdomain.axosoft.com');
$request->setClientId('my-client_id');
$request->setClientSecret('my-client-secret');
$request->setUsername('username');
$request->setPassword('password');

一个OnTime()对象需要一个包含所有账户信息的请求对象。您可以通过设置正确的参数来简单地选择连接类型(有关详细信息,请参阅官方文档)。在下面的例子中,我使用的是用户名/密码方式(这是一种更简单易用的方式)。####2- 使用您的 'ConnectionRequest' 对象实例化一个 'OnTime' 对象

use OTT\Api\OnTime;
$ontime = new OnTime($request);

您还可以向对象提供一个有效的令牌作为参数,这样它就不会自动向API请求新的令牌。

$token = $request->setSavedToken($_SESSION['access_token']);
$ontime = new OnTime($request);

####3- 从OnTime获取数据如果您想通过提供参数从OnTime(此处为项目数据)获取一些数据,您有两种可能的方法

// No arguments
$projects = $ontime->projects();

// 1° - I want the project #42
$project = $ontime->projects(42);

// 2° - I still want the same project but with more info
use OTT\Api\Filter\Projects as ProjectsFilter;
$filter = new ProjectsFilter();
$filter->setId(42);
$filter->setExtend('all');
$filter->setAttachments(true);
$project = $ontime->projects($filter);