varspool / jobadder-api-client
JobAdder API 客户端
0.0.6
2017-06-27 04:17 UTC
Requires
- php: >=7.1.0
- jane/openapi-runtime: ^1.0
- psr/http-message: ^1.0
- psr/log: ^1.0
- roave/security-advisories: dev-master
- symfony/serializer: ^2.8|^3.0
Requires (Dev)
- friendsofphp/php-cs-fixer: 2.0.0-alpha
- jane/open-api: ^1.3
- phpunit/php-invoker: ^1.1
- phpunit/phpunit: ^6.1
README
这是一个为 JobAdder 制作的 PHP API 客户端,通过 jane-openapi 生成
安装
composer require varspool/jobadder-api-client
使用方法
命名空间为 Varspool\JobAdder
。主要的客户端是 Varspool\JobAdder\Client
。客户端类提供了访问一组 API 资源的方法
$contacts = $client->contacts()->findContacts(['limit' => 3]); $ads = $client->jobAds()->getJobAds();
您也可以直接从 Varspool\JobAdder\V2\Resource
命名空间访问资源。
创建客户端实例
客户端(以及您自己创建的任何资源对象)需要配置一个 HTTP 客户端才能与 JobAdder 通信。这个 HTTP 客户端应实现 HTTPlug 的 HttpClient
或 HttpAsyncClient
。PHP 中大多数流行的 HTTP 客户端都有 HTTPPlug 适配器(例如 Guzzle)
以下是如何使用 Guzzle 6 客户端与该库一起使用的方法
-
安装 Guzzle 适配器:
composer require php-http/guzzle6-adapter
-
通过适配器将 Guzzle 客户端传递给 JobAdder 客户端
use GuzzleHttp\Client as GuzzleClient; use Varspool\JobAdder\Client as JobAdderClient; use Http\Adapter\Guzzle6\Client as GuzzleAdapter; $guzzle = new GuzzleClient($options); $http = new GuzzleAdapter($guzzle); $jobadder = new JobAdderClient($http);
OAuth 和授权头
由于客户端是注入的,您可以配置诸如基本 URI(您可能需要使用 JobAdder OAuth 响应中的 api
部分)和授权头之类的设置
// Get these both from the OAuth token response $api = 'https://localapi.jobadder.com/v2'; $token = 'abcdef01234567890'; $guzzle = new GuzzleClient([ 'base_uri' => $api, 'headers' => [ 'Authorization' => 'Bearer ' . $token ] ]);
请注意,此客户端不处理 OAuth 流;它可以在您获得有效的访问令牌后接管