README

Laravel 群接龙开放平台 SDK，提供与群接龙开放平台 API 交互的便捷方法。

功能特点

• 提供简洁的 API 调用接口
• 自动管理访问令牌（token）
• 支持缓存令牌以提高性能
• 灵活的请求配置选项
• 完善的错误处理机制
• 支持自定义响应处理

安装

使用 Composer 安装：

composer require guolei19850528/laravel-qunjielong

配置

在使用前，您需要在群接龙开放平台获取应用密钥（secret）。

使用示例

基本用法

use Guolei19850528\Laravel\Qunjielong\Open\Api;

// 创建 API 实例
$api = new Api('your_secret_key');

// 获取访问令牌
$accessToken = $api->token();

// 获取群接龙信息
$ghomeInfo = $api->getGhomeInfo();

// 使用通用请求方法调用其他接口
$result = $api->request(
    'POST',
    '/open/api/some/endpoint',
    [],
    ['param1' => 'value1', 'param2' => 'value2']
);

使用令牌刷新机制

use Guolei19850528\Laravel\Qunjielong\Open\Api;

// 创建 API 实例
$api = new Api('your_secret_key');

// 刷新令牌（自动从缓存获取或重新获取）
$api->refreshToken();

// 现在可以使用 API 调用其他接口
$ghomeInfo = $api->getGhomeInfo();

API 文档

初始化

$api = new Api($secret, $baseUrl);

• $secret: 应用密钥（必填）
• $baseUrl: API 基础地址（可选，默认：https://openapi.qunjielong.com/）

令牌管理

获取令牌

$accessToken = $api->token($query, $url, $urlParameters, $options, $responseHandler, $validatorRules);

刷新令牌

$api->refreshToken($key, $ttl);

• $key: 缓存键名（可选）
• $ttl: 缓存过期时间（可选，默认：7100秒）

接口调用

获取群接龙信息

$ghomeInfo = $api->getGhomeInfo($query, $url, $urlParameters, $options, $responseHandler, $validatorRules);

通用请求方法

$result = $api->request($method, $url, $urlParameters, $data, $query, $headers, $options, $responseHandler, $validationRules);

• $method: 请求方法（默认：GET）
• $url: 请求地址
• $urlParameters: URL 路径参数
• $data: 请求体数据
• $query: 请求查询参数
• $headers: 请求头
• $options: Guzzle 请求选项
• $responseHandler: 自定义响应处理函数
• $validationRules: 响应验证规则

许可证

MIT License

作者

• 郭磊
• 邮箱: 174000902@qq.com
• GitHub: https://gitee.com/guolei19850528/laravel-qunjielong