Skip to main content
Home
  • API 参考
  • 账户访问认证

API 认证

GlobFax 所有 API 接口统一采用双 Header 认证机制，全程加密校验，保障接口调用与数据传输安全。所有接口请求必须携带合法有效的账户凭证，未认证或认证失败的请求将被系统直接拦截。

#API 开通与管理

用户需满足账户基础条件，方可在管理后台自主生成并运维专属API凭证，每个用户支持配置一组有效凭证。

  • 开通条件： 需拥有正常状态的GlobFax注册账户，且账户套餐已开通API访问权限
  • 凭证获取： 登录GlobFax管理后台，进入「开发者」-「API 设置」，自定义备注（区分测试/生产环境），保存后即可生成凭证
  • 运维规则： 重置凭证后旧秘钥立即失效，需提前同步更新所有业务系统配置，避免调用失败

#接口认证方式

平台所有API请求统一采用双请求头认证，无参数认证方式，所有调用必须携带以下两项凭证，缺一不可：

  • X-API-Key： 你的API密钥
  • X-API-Secret： 你的API秘钥

安全警告：密钥必须严格保密，请勿将密钥泄露给第三方。建议通过环境变量、专业配置管理工具安全存储，并定期轮换秘钥。

#请求示例

#cURL 请求

shell 
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 请求

code 
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密钥或秘钥 请求头未携带 Key 或 Secret 认证参数 检查请求头完整性，补全双认证参数
401 API密钥无效 Key 与 Secret 不匹配、秘钥过期或已重置 1. 核对凭证输入是否正确；2. 后台确认密钥状态；3. 泄露/失效可重置秘钥
401 无API访问权限 账户未开通API功能、套餐不支持或权限被禁用 1. 确认套餐包含API权限；2. 核查账户状态；3. 联系客服开通权限

#常见问题

  1. 忘记/遗失凭证如何处理？
    登录管理后台「API 设置」页面，直接重置秘钥即可。重置后旧秘钥立即失效，需同步更新业务配置。

  2. 同一组 API 密钥能否用于多个应用？
    支持多应用复用同一凭证，建议区分环境合理使用。若系统监测到异常调用，将自动触发安全限制。

  3. API 认证失败的常见诱因有哪些？
    核心诱因包含：未携带认证请求头、密钥信息填写错误、账户未开通API权限、当前套餐不支持API服务。