laksmipati / php-upwork
Upwork API 的 PHP 绑定
Requires
- php: >=5.3.3
- ext-json: *
Requires (Dev)
- phpunit/php-invoker: *
- phpunit/phpunit: 3.7.*
Suggests
- ext-oauth: This extension from PECL provides OAuth consumer and provider bindings. See more under https://php.ac.cn/oauth
This package is not auto-updated.
Last update: 2024-09-26 00:09:44 UTC
README
简介
该项目基于 OAuth 1.0a,提供了一系列 Upwork API 资源,来源于 http://developers.upwork.com。
特性
以下是支持的 API 资源
- 我的信息
- 自定义支付
- 招聘
- 职位和自由职业者档案
- 搜索职位和自由职业者
- 组织
- MC
- 时间和财务报告
- 元数据
- 快照
- 团队
- 工作日记
- 活动
许可证
版权 2015 Upwork Corporation。版权所有。
php-upwork 采用 Apache License 2.0 许可证(以下简称“许可证”);除非遵守许可证规定,否则不得使用此文件。您可以在以下位置获取许可证副本:
https://apache.ac.cn/licenses/LICENSE-2.0
除非适用法律要求或书面同意,否则在许可证下分发的软件按“原样”提供,不提供任何明示或暗示的保证或条件。有关许可证的具体语言、权限和限制,请参阅许可证。
服务等级协议 (SLA)
此 API 的使用受以下使用条款约束:
https://developers.upwork.com/api-tos.html
应用程序集成
要集成此库,您需要以下条件
- PHP >= 5.3.0
- OAuth 扩展已安装(可选),我们推荐使用官方 pecl 扩展,但如果你想使用自己的库,需要从 composer json 中删除 'ext-oauth' 行,或者不使用 composer(这也是可选的)。在这种情况下,您需要在配置选项中设置 'authType' 参数。源代码中包含一个可以使用的 oauth-php 库,如果您想为您的客户端库创建身份验证层,请参阅 AuthTypes 目录中的更多内容。
- Composer 已安装(可选)
示例
此外,在 example 目录中提供了一个完整的示例。这包括 console.php,用于获取访问令牌并请求非基于 Web 的应用程序的数据,以及 web.php 用于基于 Web 的应用程序。您还可以找到 console-own-auth-lib.php 文件,用于使用自己的 php 客户端与 Upwork 库一起使用。
还包括一个 composer.json 文件,用于与 Composer 一起使用。
Composer
为了轻松集成到您的应用程序中,我们建议使用 Composer 安装依赖项。
以下是您可以使用的一个简单的 composer.json 文件示例
{
"name": "upwork/my-oauth-app",
"require": {
"upwork/php-upwork": "dev-master"
}
}
使用 Composer 安装
将 upwork/php-upwork 添加到您的 composer.json 文件中,简单示例
{
"name": "my/my-oauth-app",
"require": {
"upwork/php-upwork": "v1.1.0" // note: the latest release is recommended
}
}
运行以下命令 /usr/local/bin/composer.phar update
输出应类似以下内容
Loading composer repositories with package information
Updating dependencies (including require-dev)
- Installing upwork/php-upwork (v1.1.0)
Downloading: 100%
Writing lock file
Generating autoload files
重要提示:此库支持不同的 OAuth 客户端,默认情况下,它需要 PECL PHP 扩展(更多详情请参考 https://php.ac.cn/oauth)。请确保已安装。如果您不想使用它或没有安装的可能性,可以使用预加载的 php 库,称为 oauth-php(在 vendor-src/README 中了解更多)。
如果已安装 ext-oauth,请将 vendor/upwork/php-upwork/example/console.php 复制到 myapp.php
或者
如果您想使用预加载的PHP库作为OAuth客户端,请将vendor/upwork/php-upwork/example/console-own-auth-lib.php复制到myapp.php。
否则
- 检查
vendor/upwork/php-upwork/src/Upwork/API/AuthTypes/并创建您自己的OAuth封装器。 - 将
vendor/upwork/php-upwork/example/console-own-auth-lib.php复制到myapp.php。 - 之后,更新
myapp.php配置部分中的'authType'属性,并指定您的处理程序名称。
注意:如果您正在创建基于Web的应用程序,请使用web.php示例。
打开myapp.php,并输入您之前从API中心获取的consumerKey和consumerSecret。这就完成了。以php myapp.php的方式运行您的应用程序,享受乐趣。
通过下载源代码进行安装
从https://github.com/upwork/php-upwork/releases下载最新版本,例如https://github.com/upwork/php-upwork/archive/v1.1.0.tar.gz,并将其解压到您的应用程序根目录中的vendor/upwork文件夹。
创建vendor/autoload.php,一个可能的简单变体如下:
require_once __DIR__ . '/upwork/php-upwork-1.1.0/src/Upwork/API/constants.php';
spl_autoload_register('UpworkVendorAutoloader');
function UpworkVendorAutoloader($_class)
{
$path = __DIR__ . '/upwork/php-upwork-1.1.0/src/' . str_replace('\\', '/', $_class) . '.php';
include_once $path;
}
打开myapp.php,并输入您之前从API中心获取的consumerKey和consumerSecret。
这就完成了。以php myapp.php的方式运行您的应用程序,享受乐趣。