Appearance
快速开始
本指南将帮助您在几分钟内完成帮图开放API的接入。
1. 基础路径
所有 API 请求均使用以下基础路径:
text
https://openapi.bangtu-ai.com/openApi完整请求地址由基础路径与接口请求地址拼接而成。
2. 获取 API Key
测试 API Key
我们提供了一个固定的测试 API Key,可用于快速体验和接口联调:
text
btg1eqQmDDmJKi1Q9pcTJjUXr8mArqW7测试 API Key 仅供测试使用。正式接入时,建议申请专属 API Key。
专属 API Key
如需正式接入,请联系我们公司为您开通专属 API Key。申请时请提供公司名称、联系人及联系方式,以及计划使用的 API 类型。
预计八月底上线 API Key 自动生成功能。上线后,API Key 将与帮图用户账号绑定,用户可自行生成和管理 API Key。
3. 认证方式
所有 API 请求需要在 Header 中携带 API Key:
bash
curl -X POST https://openapi.bangtu-ai.com/openApi/...... \
-H "apiKey: YOUR_API_KEY" \4. 响应格式
所有 API 返回统一的 JSON 格式:
json
{
"code": 0,
"message": "success",
"data": {
// 具体业务数据
}
}状态码说明
| code | 说明 |
|---|---|
| 200 | 请求成功 |
| 500001 | IP 黑名单拦截,请联系管理员 |
| 500003 | 请求过于频繁,请稍后再试 |
| 401 | appKey 不存在或已禁用 |
| 2034 | 您已切换企业,请切换企业后重试 |
| 2003 | 没有相关权限 |
5. 更多帮助
如需获取更详细的接口文档,请参考各专业 API 页面。如有任何问题,请联系技术支持团队。