凭据说明

凭据说明获取方式
Client ID应用标识符开放平台控制台创建应用后获取
Client Secret应用密钥创建应用时生成,仅显示一次
Open Access Key开放访问密钥在应用设置中生成
口诀三把钥匙缺一不可:ID 定身份、Secret 证权限、Access Key 开通道

SDK 中配置

最直接的方式是在初始化 GausiumSDK 时传入三个凭据参数:

async with GausiumSDK(
    client_id="your-client-id",
    client_secret="your-client-secret",
    open_access_key="your-access-key"
) as sdk:
    robots = await sdk.robot.list()

环境变量方式

推荐在生产环境中使用环境变量,避免凭据硬编码在源代码中:

export GAUSIUM_CLIENT_ID=your-client-id
export GAUSIUM_CLIENT_SECRET=your-client-secret
export GAUSIUM_OPEN_ACCESS_KEY=your-access-key

浏览器端配置

文档站内置了 API 调试控制台,凭据存储在浏览器的 localStorage 中,仅在本地生效,不会上传到服务器。

  1. 打开浏览器开发者工具控制台
  2. 执行 localStorage.setItem() 写入凭据 JSON
  3. 刷新页面,控制台将自动读取凭据
localStorage.setItem('gs_credentials', JSON.stringify({
  client_id: 'your-client-id',
  client_secret: 'your-client-secret',
  open_access_key: 'your-access-key'
}));

Token 生命周期

OAuth2 认证成功后,服务端返回一个有时效的 access_token。SDK 内部通过 Auth 模块自动管理 Token 的获取与刷新,开发者无需手动介入续期流程。

测试连接

使用 curl 手动请求 OAuth 端点,验证凭据是否正确配置:

curl -X POST https://openapi.gs-robot.com/gas/api/v1alpha1/oauth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=urn:gaussian:params:oauth:grant-type:open-access-token' \
  -d 'client_id=YOUR_CLIENT_ID' \
  -d 'client_secret=YOUR_CLIENT_SECRET' \
  -d 'open_access_key=YOUR_OPEN_ACCESS_KEY'

推荐做法
  • 使用环境变量存储凭据,不硬编码
  • 定期轮换 Client Secret
不推荐
  • 将凭据提交到 Git
  • 在前端代码中明文存储 Secret
常见误区
  • Client Secret 创建时仅显示一次,未保存则需重新生成
  • 环境变量未 export 导致子进程读取不到

生产环境使用环境变量或密钥管理服务