接口认证指南¶
概述¶
所有 API 接口均采用双 Header 认证机制，确保数据传输安全可靠。在进行任何 API 调用前，您需要完成以下准备工作：
- 开通 API 功能：确认账户套餐支持 API 功能。
- 获取 API 凭证：在管理后台生成 API Key 和 Secret。
- 正确携带认证信息：在每个请求的 Header 中提供凭证。
API 端点： http://api.globfax.com
开通 API 功能¶
前提条件¶
- 拥有有效的 GlobFax 账户
- 账户已购买支持 API 功能的套餐
设置 API 密钥和秘钥¶
- 登录 GlobFax 管理后台
- 点击「开发者」菜单，进入「API 设置」页面
- 为密钥设置一个易于识别的名称（例如
生产环境、测试环境） - 点击确认保存
API 凭证说明
- API Key：用于标识您的账户，可使用方便识别的名称
- API Secret：用于身份验证，必须严格保密，切勿泄露
- 每个用户只能设置一个 API，但可以随时调整或重置
- 建议定期更换 API Secret 以提高安全性
管理 API 凭证¶
在「API 设置」页面，您可以：
- 查看当前 API 密钥信息
- 修改 API 密钥名称
- 重置 API Secret（生成新的秘钥）
重置 API Secret
重置 API Secret 后，旧的秘钥将立即失效，请确保及时更新所有使用该 API 的应用配置
认证机制¶
认证方式¶
所有 API 请求必须通过 HTTP Header 方式传递认证信息：
X-API-Key: your_api_key_here
X-API-Secret: your_api_secret_here
安全警告
API Secret 是敏感信息，请勿硬编码在客户端代码或公开仓库中。建议使用环境变量或安全的配置管理工具存储。
请求示例¶
cURL¶
curl -X GET "http://api.globfax.com/api/v2/faxes" \
-H "X-API-Key: your_api_key_here" \
-H "X-API-Secret: your_api_secret_here" \
-H "Content-Type: application/json"
原始 HTTP 请求¶
GET /api/v2/faxes HTTP/1.1
Host: api.globfax.com
X-API-Key: your_api_key_here
X-API-Secret: your_api_secret_here
Content-Type: application/json
错误处理¶
认证相关错误¶
| HTTP 状态码 | 错误信息 | 原因 | 解决建议 |
|---|---|---|---|
| 401 | 缺少API密钥或秘钥 | 请求中未提供 API Key 或 API Secret | 检查请求头是否正确包含认证信息 |
| 401 | API密钥无效 | 提供的 API Key 和 API Secret 不匹配 | 1. 检查 API Key 和 Secret 是否正确 2. 登录管理平台确认密钥状态 3. 如密钥泄露，立即重置 API Secret |
| 401 | 无API访问权限 | 账户套餐不支持 API 功能或 API 功能被禁用 | 1. 确认账户套餐支持 API 功能 2. 检查账户状态是否正常 3. 联系客服开通 API 权限 |
通用错误格式
关于错误响应的通用格式及常见 HTTP 状态码，请参考 API 概述 中的「错误处理」章节。
常见问题¶
Q: 忘记 API Secret 怎么办？¶
A: 登录管理后台，进入「API 设置」页面，点击「重置 API Secret」按钮生成新的秘钥。旧秘钥将立即失效。
Q: 可以在多个应用中使用同一个 API 密钥吗？¶
A: 可以，但建议根据实际需求合理使用。如有异常使用情况，系统可能会进行安全限制。
Q: API 认证失败可能的原因有哪些？¶
A: 常见原因包括：1) 未提供认证信息；2) API Key 或 Secret 错误；3) 账户 API 功能未开通；4) 账户套餐不支持 API 功能。