接入指南
接入准备流程
庆鱼开发指南
统一参数说明
撞库接口
客户接入接口
省市地区编码
错误码
UUID生成方法
星级回传接口
接口调用流程
8位撞库接口
本文档使用 MrDoc 发布
-
+
首页
统一参数说明
## 开发准备 - 生成你的accessKey和publicKey - 确定要操作的接口 ## 接口说明 - 客户接入接口:客户接入接口是指通过API向庆鱼系统新建1个客户 ## 入参说明 ### 基础入参 每次API请求,身份标识(accessKey) 和 请求记录id(requestId)为基础参数。 | 字段 | 类型 | 是否必填 | 说明 | | --- | --- | --- | --- | | accessKey | String | 是 | 身份标识 | | requestId | String | 是 | 本次请求唯一id(<span style="color:red">订单id</span>)<br/>(在每次请求时生成一个新的UUID) <br/>(100位以内随机字符串) | | data | Object\|Array | 是 | 参数对象或者参数数组 | | | | | <span style="color:red">注意 客户接入接口的data需要传入数组格式的数据</span> ### 入参demo ```json { "accessKey":"abc123def", "requestId":"1df89154-939a-c364-d2bf-29379dd8cb47", "data":[ { "key1":"value", "key2":"value" } ] } ``` ## 回参说明 ### 基础回参 每次API请求,无论成功与否,接口都会有标准的JSON格式信息返回。 成功请求格式规范: ```json { "code":200, "msg": "操作成功", "requestId":"1df89154-939a-c364-d2bf-29379dd8cb47", "success": true, "data": { } } ``` | 字段 | 类型 | 是否必传 | 说明 | | --- | --- | --- | --- | | code | Integer | 是 | 状态码 200标识操作成功 | | msg | String | 是 | 提示信息 | | requestId | String | 是 | 本次请求唯一id | | data | Object\|Array | 否 | 返回对象或数组 | | success | Boolean | 是 | 成功标志。true表示操作成功。| 失败请求格式规范: ```json { "code":60001, "msg": "未传入参数accessKey", "requestId":"1df89154-939a-c364-d2bf-29379dd8cb47", "success": false, "data": { } } ``` | 字段 | 类型 | 是否必传 | 说明 | | --- | --- | --- | --- | | code | Integer | 是 | 错误码 | | msg | String | 是 | 提示信息 | | requestId | String | 是 | 本次请求唯一id | | data | Object\|Array | 否 | 返回对象或数组 | | success | Boolean | 是 | 成功标志。false表示操作失败。|
admin
2023年5月12日 18:43
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
分享
链接
类型
密码
更新密码