benborla/jobadder-api-client

JobAdder API 客户端

dev-master 2023-04-20 14:31 UTC

This package is auto-updated.

Last update: 2024-09-20 17:24:41 UTC


README

这是一个针对 JobAdder 的 PHP API 客户端,通过 jane-openapi 生成。

安装

composer require varspool/jobadder-api-client

用法

命名空间为 BenBorla\JobAdder。主要的客户端是 BenBorla\JobAdder\Client。客户端类提供对一组 API 资源的访问。

$contacts = $client->contacts()->findContacts(['limit' => 3]);
$ads = $client->jobAds()->getJobAds();

您也可以直接从 BenBorla\JobAdder\V2\Resource 命名空间访问资源。

创建客户端实例

客户端(以及您自己创建的任何资源对象)需要配置 HTTP 客户端才能与 JobAdder 通信。这个 HTTP 客户端应该实现来自 HTTPlugHttpClientHttpAsyncClient。PHP 中大多数流行的 HTTP 客户端都有 HTTPPlug 适配器(例如 Guzzle)。

以下是如何使用 Guzzle 6 客户端与这个库一起使用的示例

  • 安装 Guzzle 适配器: composer require php-http/guzzle6-adapter

  • 通过适配器将 Guzzle 客户端传递给 JobAdder 客户端

    use GuzzleHttp\Client as GuzzleClient;
    use BenBorla\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 流程;它可以在您获得有效访问令牌后接管。