rabotaru/oauth-client

rabota.ru API Oauth客户端

v1.0.0 2019-04-22 17:49 UTC

This package is not auto-updated.

Last update: 2024-09-30 23:41:05 UTC


README

这是一个提供访问rabota.ru API接口的库。关于API的使用和可用方法,请参阅文档

BSD Zero Clause License

安装

使用composer进行安装

composer require rabotaru/oauth-client

使用

安装客户端后,您可以直接使用它从API获取数据。

  1. 将仓库克隆到任何文件夹。
  2. 在Web服务器设置中创建一个新的主机,指向包含客户端的文件夹。
  3. 编辑config.php文件。指定以下参数:app_id - 应用程序的唯一标识符,在网站上注册应用程序时获得。secret - 应用程序的密钥,在注册应用程序时获得。api.url - 请求的路径。api.params - 请求参数。
  4. 在浏览器中打开index.php文件。

方法描述

使用基于OAuth2.0协议的授权机制来访问API方法。

更多详情请参阅这里

提供访问的步骤如下

  1. 应用程序请求授权。获取代码
  2. 使用代码获取授权令牌。
  3. 在发送到API的请求中通过HTTP头部传递令牌。

使用RabotaApi/Client类的实例发送请求和授权。

创建客户端时,通过构造函数传递以下参数:$appId - 在网站上注册应用程序时获得的唯一应用程序标识符,$secret - 在注册应用程序时获得的密钥,$token - 授权令牌(如果已获取令牌),$expires - 令牌有效期(如果已获取令牌)。

###创建客户端示例

$appId = 3803;
$secret = '7oRFT6vBEaohqud4PYT2ZmIUL1Kn3uBB';
$token = 'a4nQuLXM7x46sDwrUlrCbsg9w1f2xzxn';
$expires = 86000;


$client = new Client(
   $appId, $secret, $token, $expires
);

###获取授权页面链接

$url = $client->getAuthenticationUrl($redirect)

其中$redirect - 是包含代码的重定向链接

###发送获取令牌的请求

$code = $_GET['code'];
$client->requestToken($code);

其中$code - 是在授权后获得的代码

发送API请求

    $route = '/v4/me.json';
    $params =  [];
    $method = "POST";
    
    $response = $client->fetch(
       $route, $params, $method 
    );
    
    echo $response->getJsonDecode();

在index.php文件中可以查看带有授权的API请求示例。