Skip to main content
API Key 是调用 GEOBase 开发者 API 的唯一凭证,泄露后将导致他人以你的身份调用接口并消耗资源。请按以下建议保管与使用。

密钥保管

  • API Key 只放服务端。 不要写入浏览器前端、移动端 App、小程序包体或公开代码仓库。
  • 通过环境变量或密钥管理系统注入,不要硬编码在源码或配置文件中提交到版本库。
  • 按需收紧权限:仅为 Key 授予其业务实际需要的 apiCode 调用权限。

网络与访问控制

  • 配置 IP 白名单:在管理后台为 Key 配置允许调用的出口 IP;未配置白名单时默认放行。
  • 设置有效期:为 Key 设置明确到期时间并定期轮换,避免长期使用同一把 Key。
  • 全程 HTTPS:生产环境务必通过 HTTPS 调用,避免明文传输。

日志与排错

  • 不要在日志中打印完整 API Key,必要时只保留前缀或做脱敏处理。
  • 生产环境保存 requestId:记录每次调用的 AIBase-Request-Id,便于事后定位。
  • 异常排查保留四要素:HTTP 状态码、业务 code、msg 与 requestId。

响应解析安全

  • 同时使用 HTTP 状态与业务 code 判断结果,不要只依赖 msg 文本。
  • 错误响应的 data 可能为 null;分组结构接口无数据时可能返回空对象或空数组,解析时做好空值兼容。

常见问题

403、data 结构差异等高频疑问。