跳转至

API 使用说明☍

简介☍

欢迎使用我们的API服务。本文档将帮助您快速了解和使用我们的API接口。我们的API设计遵循RESTful规范，支持JSON格式的数据交互，并提供完整的OpenAPI文档供您参考。

快速开始☍

  1. 选择合适的接入点
  2. 获取访问令牌（Access Token）
  3. 调用API接口

服务接入点☍

环境 接入点 说明
开发环境 https://api-dev.zashigaofa.cn 用于开发和测试，可直接使用
私有部署 {your api server} 独立部署版本的服务器地址

认证方式☍

所有API请求都需要进行身份认证。我们支持以下认证方式：

  1. Bearer Token认证
  2. API Key认证
  3. OAuth2.0认证

Bearer Token认证示例☍

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
// 在请求头中添加Authorization
const headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  'Content-Type': 'application/json'
};

// 发起API请求
fetch('https://api.example.com/v2/resource', {
  method: 'POST',
  headers: headers,
  body: JSON.stringify({
    key: 'value'
  })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

API 集成☍

所有API均遵循RESTful设计原则，您可以使用任何支持HTTP的编程语言直接调用。我们建议：

  1. 使用HTTPS进行安全传输
  2. 实现请求重试机制
  3. 做好错误处理
  4. 注意请求频率限制

API分类与详细文档☍

我们提供了多种功能模块的API，每个模块的具体接口说明、参数要求和响应格式，请参考对应模块的API文档。下方"在线调试"部分列出了所有可用的API模块，您可以通过访问OpenAPI YAML文件或使用在线调试工具来了解每个API的详细信息。

每个API文档包含： - 接口路径 - 请求方法 - 请求参数 - 响应格式 - 错误码说明 - 示例代码

常见集成场景☍

以下是一些常见的API集成场景：

  1. 用户认证流程：通过用户API和令牌API实现登录和认证
  2. 应用管理：使用应用API和应用配置API管理您的应用
  3. 支付与订单：通过订单API和各支付渠道API实现支付功能
  4. 数据存储：利用应用数据库API和应用存储API实现数据持久化

在线调试☍

提示

使用在线调试工具，您可以在实际集成前验证API的行为，加快开发进度。

调试建议
  1. 建议先在开发环境进行调试
  2. 使用调试工具可以查看详细的请求/响应信息
  3. 可以保存调试历史，方便后续参考
API OpenAPI YAML 在线调试
用户 访问 调试
用户 - 外部账号 访问 调试
用户 - 令牌 访问 调试
用户 - 资产 访问 调试
用户 - 好友 访问 调试
用户 - 地址 访问 调试
应用 访问 调试
应用 - 数据库 访问 调试
应用 - 文件 访问 调试
应用 - 订单 访问 调试
应用 - 开放授权 访问 调试
服务商 - 微信 访问 调试
服务商 - 支付宝 访问 调试
服务商 - 钉钉 访问 调试

评论