使用Python PowerSchool库对接API需如何编写带OAuth的插件XML

步骤1：编写OAuth配置XML文件 #

首先创建一个后缀为.xml的文件，可直接使用下方模板，替换对应自定义内容即可：

<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://plugin.powerschool.pearson.com"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://plugin.powerschool.pearson.com plugin.xsd"
        name="Python API 集成插件"
        version="1.0"
        description="用于Python PowerSchool库调用SIS API的OAuth授权插件">
    <oauth>
        <client id="自定义客户端ID，比如ps_python_api_2024" secret="自定义密钥，建议至少16位随机字符">
            <scopes>
                <!-- 按需开启需要的API权限，下方是常用基础权限 -->
                <scope>https://powerschool.com/auth/core.api.student.read</scope>
                <scope>https://powerschool.com/auth/core.api.course.read</scope>
                <scope>https://powerschool.com/auth/core.api.attendance.read</scope>
            </scopes>
        </client>
    </oauth>
    <permissions>
        <permission name="Data Access API">
            <description>允许调用PowerSchool公开数据接口</description>
        </permission>
    </permissions>
</plugin>

注意：请自行保存你填写的client id和secret，后续Python连接API时需要用到这两个参数

步骤2：上传并启用插件 #

• 登录PowerSchool管理后台，进入路径：系统 > 系统设置 > 插件管理面板
• 点击页面右上角的「安装」按钮，选择你刚才创建的XML文件上传
• 上传完成后，在插件列表中找到你刚上传的插件，点击插件名称进入详情页
• 勾选「启用」选项，保存设置，此时插件状态会变为已启用
• 回到插件详情页，确认OAuth客户端ID和密钥和你XML中填写的一致即可

步骤3：验证配置是否生效 #

你可以使用下方代码测试连接是否正常：

from powerschool import PowerSchool

# 替换为你的实际信息
ps = PowerSchool(
    base_url="你的PowerSchool实例地址",
    client_id="你XML中填写的客户端ID",
    client_secret="你XML中填写的密钥"
)

# 测试获取学生数据（如果权限开启正常会返回结果）
students = ps.get_students()
print(students)

内容的提问来源于stack exchange，提问作者Dance Party