如何正确使用 Xero OAuth2 刷新令牌获取新访问令牌与刷新令牌

梦明同学_3239

梦明同学_3239

2026-10-20

290人浏览

原创

如何正确使用 Xero OAuth2 刷新令牌获取新访问令牌与刷新令牌

本文详解 Xero API 中 offline_access 的实际应用,重点解决调用刷新令牌时出现 unsupported_grant_type 错误的原因,并演示如何通过 League OAuth2 客户端正确获取新的访问令牌(access token)及可复用的刷新令牌(refresh token)。

本文详解 xero api 中 `offline_access` 的实际应用,重点解决调用刷新令牌时出现 `unsupported_grant_type` 错误的原因,并演示如何通过 league oauth2 客户端正确获取新的访问令牌(access token)及**可复用的刷新令牌(refresh token)**。

在 Xero OAuth2 授权流程中,启用 offline_access 权限是获得长期有效刷新令牌(refresh token)的前提。该权限需在初始授权请求(Authorization URL)中显式声明,例如:

$authUrl = $provider->getAuthorizationUrl([
    'scope' => 'openid profile email accounting.transactions offline_access'
]);

⚠️ 注意:仅在应用设置中勾选 offline_access 并不生效——必须在每次授权请求的 scope 参数中包含 offline_access,Xero 才会返回可用于长期刷新的 refresh token。

你当前遇到的 unsupported_grant_type 错误,根本原因在于手动构造的 Guzzle 请求存在两个关键问题:

  1. 请求体格式错误:Xero 要求 application/x-www-form-urlencoded 格式,但你传递的是 JSON 字符串('body' => '{"grant_type":...}'),服务器无法解析;
  2. 缺少必要参数:除 grant_type 和 refresh_token 外,还必须提供 client_id(部分场景下需 client_secret,取决于客户端类型);且 Basic Auth 头中的 $authpas 必须是 base64_encode("client_id:client_secret")。

✅ 正确做法是优先使用已封装好的 OAuth2 客户端库(如 league/oauth2-client),它自动处理编码、头信息和参数校验:

use League\OAuth2\Client\Provider\GenericProvider;

$provider = new GenericProvider([
    'clientId'                => $client,
    'clientSecret'            => $secret,
    'redirectUri'             => 'https://site/xeroreports',
    'urlAuthorize'            => 'https://login.xero.com/identity/connect/authorize',
    'urlAccessToken'          => 'https://identity.xero.com/connect/token',
    'urlResourceOwnerDetails' => 'https://identity.xero.com/resources',
]);

// ✅ 正确:使用 refresh_token 授权类型获取新令牌
try {
    $newAccessToken = $provider->getAccessToken('refresh_token', [
        'refresh_token' => $xero_refresh,
    ]);

    // ? 关键:$newAccessToken 是对象,不是字符串!
    $accessToken  = $newAccessToken->getToken();        // 新的 access_token(JWT)
    $refreshToken = $newAccessToken->getRefreshToken(); // 新的 refresh_token(可能轮换)
    $expires      = $newAccessToken->getExpires();      // 过期时间戳(秒级)

    echo "Access Token: {$accessToken}\n";
    echo "Refresh Token: {$refreshToken}\n"; // ✨ 这才是你要的新 refresh token
} catch (\Exception $e) {
    error_log("Token refresh failed: " . $e->getMessage());
}

? 重要说明:

  • Xero 在每次成功刷新后可能返回一个新的 refresh token(并非总是不变),因此务必每次刷新后都持久化存储 getRefreshToken() 的返回值;
  • offline_access 授予的 refresh token 默认有效期为 60 天,且每次刷新会重置过期时间(即“滚动过期”);
  • 若手动使用 Guzzle,请严格按 Xero 官方文档 构造请求:
$authHeader = base64_encode("{$client}:{$secret}");

$response = $client->request('POST', 'https://identity.xero.com/connect/token', [
    'form_params' => [
        'grant_type'    => 'refresh_token',
        'refresh_token' => $xero_refresh,
        'client_id'     => $client,
    ],
    'headers' => [
        'Authorization' => 'Basic ' . $authHeader,
        'Content-Type'  => 'application/x-www-form-urlencoded',
    ],
]);

? 总结:避免 unsupported_grant_type 的核心是——不用 JSON body,用 form_params 提交,确保 grant_type=refresh_token 且认证头正确;而最佳实践是信任成熟 OAuth2 客户端,直接调用 getAccessToken('refresh_token', [...]) 并通过对象方法提取 getRefreshToken(),安全、简洁、符合规范。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11064

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6441

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2155

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4068

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4774

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3751

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5377

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4222

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12122

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.8万人学习