README

oDesk API 的 PHP 绑定

简介

本项目基于 OAuth 1.0a，提供从 http://developers.odesk.com 获取的 oDesk API 资源集。

特性

以下是支持的 API 资源

我的信息
自定义付款
招聘
职位和自由职业者档案
搜索职位和自由职业者
组织
MC
时间和财务报告
元数据
快照
团队
工作日志
活动

许可

php-odesk 在 Apache License, Version 2.0 许可下发布（以下简称“许可”）；除非您遵守许可，否则不得使用此文件。您可以在以下地址获取许可副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或经书面同意，否则在许可下分发的软件按“现状”提供，不提供任何明示或暗示的保证或条件。有关许可的具体语言，请参阅许可。

服务等级协议

此 API 的使用受以下使用条款约束：

https://developers.odesk.com/api-tos.html

应用程序集成

要集成此库，您需要以下条件：

PHP >= 5.3.0
OAuth 扩展已安装（可选），我们建议使用官方 pecl 扩展，但如果您想使用自己的库，您需要从 composer json 中删除 'ext-oauth' 行，或者不使用 composer，这也是可选的。在这种情况下，您需要在配置选项中设置 'authType' 参数。源代码中包含一个可以使用的 oauth-php 库作为替代方案。如果您想为自己的客户端库创建认证层，请参阅 AuthTypes 目录中的更多内容。
Composer 已安装（可选）

示例

此外，在 example 目录中提供了一个完整的示例。这包括获取访问令牌并请求非基于 Web 的应用程序数据的 console.php，以及用于基于 Web 的应用程序的 web.php。还有一个 console-own-auth-lib.php 可用于与 oDesk 库一起使用您自己的 php 客户端。

此外，还包括一个 composer.json 文件，用于与 Composer 一起使用。

Composer

为了轻松集成到您的应用程序中，我们建议使用 Composer 安装依赖项。

以下是您可以使用的简单 composer.json 文件示例

{
    "name": "odesk/my-oauth-app",
    "require": {
        "odesk/php-odesk": "dev-master"
    }
}

使用Composer安装

将odesk/php-odesk添加到您的composer.json中，简单示例

{
    "name": "my/my-oauth-app",
    "require": {
        "odesk/php-odesk": "v0.1.18" // note: the latest release is recommended
    }
}

运行以下命令 /usr/local/bin/composer.phar update

输出应类似于

Loading composer repositories with package information
Updating dependencies (including require-dev)
  - Installing odesk/php-odesk (v0.1.18)
    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/odesk/php-odesk/example/console.php复制到myapp.php

或者

如果您想使用预加载的php库作为OAuth客户端，请将vendor/odesk/php-odesk/example/console-own-auth-lib.php复制到myapp.php

否则

检查vendor/odesk/php-odesk/src/oDesk/API/AuthTypes/并为您自己的OAuth创建包装器
将vendor/odesk/php-odesk/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/odesk/php-odesk/releases下载最新版本，例如https://github.com/odesk/php-odesk/archive/v0.1.18.tar.gz，并将其解压到您的应用程序根目录下的vendor/odesk文件夹中。

创建vendor/autoload.php，一个可能的简单变体可能是

require_once __DIR__ . '/odesk/php-odesk-0.1.18/src/oDesk/API/constants.php';

spl_autoload_register('oDeskVendorAutoloader');

function oDeskVendorAutoloader($_class)
{
    $path = __DIR__ . '/odesk/php-odesk-0.1.18/src/' . str_replace('\\', '/', $_class) . '.php';
    include_once $path;
}

打开myapp.php并输入您之前从API中心获取的consumerKey和consumerSecret。

这就完成了。以php myapp.php运行您的应用程序并享受乐趣。

odesk / php-odesk

维护者

详情