SPFX WebPart调用API获取租户网站集/网站失败求助

我们尝试通过以下搜索API端点获取租户内所有站点/网站：

https://{mycompany}.sharepoint.com/_api/search/query?querytext='contentclass:STS_Site contentclass:STS_Web'&selectproperties='Title,Path'&rowlimit=500

手动在浏览器输入该URL可正常返回标题和站点URL，但在SPFX组件中调用时抛出错误，即使已拥有租户管理员权限仍无法解决。

1. 配置SPFX组件的API权限 #

在项目根目录的package-solution.json文件中添加必要的权限请求：

"webApiPermissions": [
  {
    "resource": "SharePoint",
    "scope": "Search.Query"
  },
  {
    "resource": "Microsoft Graph",
    "scope": "Sites.Read.All"
  }
]

部署组件包后，需由租户管理员登录SharePoint管理中心，在高级 > API访问页面批准这些权限请求。

2. 使用SPHttpClient发起认证请求 #

SPFX中必须使用框架内置的SPHttpClient处理请求，它会自动注入当前用户的认证令牌，避免手动处理身份验证问题：

import { SPHttpClient, SPHttpClientResponse } from '@microsoft/sp-http';

// 在组件类的方法内执行请求逻辑
const siteUrl = this.context.pageContext.web.absoluteUrl;
const queryText = encodeURIComponent('contentclass:STS_Site contentclass:STS_Web');
const selectProps = encodeURIComponent('Title,Path');
const apiUrl = `${siteUrl}/_api/search/query?querytext=${queryText}&selectproperties=${selectProps}&rowlimit=500`;

this.context.spHttpClient.get(apiUrl, SPHttpClient.configurations.v1)
  .then((response: SPHttpClientResponse) => {
    if (!response.ok) {
      throw new Error(`请求失败，状态码：${response.status}`);
    }
    return response.json();
  })
  .then((searchResults) => {
    // 处理返回的搜索结果
    console.log(searchResults);
  })
  .catch((error) => {
    console.error("调用API出错：", error);
  });

3. 确保请求参数正确编码 #

直接拼接未编码的参数可能导致URL解析错误，使用encodeURIComponent对查询文本和属性列表进行编码，避免特殊字符干扰。

4. 验证权限生效状态 #

即使是租户管理员，SPFX组件的权限是独立于用户权限的。检查SharePoint管理中心的API权限审批状态，确保已批准添加的Search.Query和Sites.Read.All权限。未批准的权限会导致403禁止访问错误。

内容的提问来源于stack exchange，提问作者kmurali krishna