接口说明
认证方式
所有接口都需要提供 appid 和 key 进行身份认证。
认证信息可以通过以下方式传递:
- HTTP Headers:
X-App-ID和X-App-Key - URL Query:
?appid=xxx&key=xxx - JSON Body:
{"appid":"xxx","key":"xxx"}
接口域名
https://sj.jiaxing98.top
返回格式
所有接口统一返回JSON格式,基本结构如下:
{
"code": 200, // 200表示成功,其他值表示失败
"message": "提示信息",
"data": {} // 返回的数据
}
批量添加数据接口
POST /api/sj1/add
批量添加用户申请数据,支持去重检查
请求方式
POST
请求URL
https://sj.jiaxing98.top/api/sj1/add
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appid | string | 是 | 应用ID |
| key | string | 是 | 应用密钥 |
| data | array | 是 | 数据数组 |
| data[].name | string | 是 | 姓名 |
| data[].mobile | string | 是 | 手机号 |
| data[].id_card | string | 是 | 身份证号 |
请求示例
POST https://sj.jiaxing98.top/api/sj1/add
Content-Type: application/json
X-App-ID: your_appid
X-App-Key: your_key
{
"appid": "your_appid",
"key": "your_key",
"data": [
{
"name": "张三",
"mobile": "13800138001",
"id_card": "110101199001011234"
},
{
"name": "李四",
"mobile": "13800138002",
"id_card": "110101199002021234"
}
]
}
返回示例
{
"code": 200,
"message": "批量写入完成",
"data": [
{
"name": "张三",
"mobile": "13800138001",
"id_card": "110101199001011234",
"status": "成功",
"message": "插入成功"
},
{
"name": "李四",
"mobile": "13800138002",
"id_card": "110101199002021234",
"status": "已存在",
"message": "已存在"
}
]
}
说明
- 系统会自动检查重复记录(手机号+身份证号+appid)
- 每条数据会返回独立的处理结果
- status 可能值:成功、已存在、失败、错误
- ID从1000000开始自动递增
查询数据列表接口
GET /api/sj1/query
查询数据列表,支持分页和条件查询
请求方式
GET
请求URL
https://sj.jiaxing98.top/api/sj1/query
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appid | string | 是 | 应用ID |
| key | string | 是 | 应用密钥 |
| page | int | 否 | 页码,默认1 |
| size | int | 否 | 每页数量,默认20 |
| name | string | 否 | 姓名筛选 |
| mobile | string | 否 | 手机号筛选 |
| idcard | string | 否 | 身份证号筛选 |
请求示例
GET https://sj.jiaxing98.top/api/sj1/query?appid=your_appid&key=your_key&page=1&size=20
返回示例
{
"code": 200,
"message": "查询成功",
"data": {
"list": [
{
"id": 1000001,
"name": "张三",
"mobile": "13800138001",
"id_card": "110101199001011234",
"appid": "your_appid",
"time": null,
"created_at": "2025-11-20T06:56:57.569Z",
"updated_at": "2025-11-20T06:56:57.569Z"
}
],
"total": 100,
"page": 1,
"size": 20
}
}
统计数据接口
GET/POST /api/sj1/count
统计数据总数,支持简单统计和批量条件查询
模式一:简单统计(GET)
请求方式:GET
请求URL:
https://sj.jiaxing98.top/api/sj1/count
请求参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appid | string | 是 | 应用ID |
| key | string | 是 | 应用密钥 |
请求示例:
GET https://sj.jiaxing98.top/api/sj1/count?appid=your_appid&key=your_key
返回示例:
{
"code": 200,
"message": "统计成功",
"data": 1523
}
模式二:批量条件查询(POST)
请求方式:POST
请求URL:
https://sj.jiaxing98.top/api/sj1/count
请求参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appid | string | 是 | 应用ID(通过Header或Body传递) |
| key | string | 是 | 应用密钥(通过Header或Body传递) |
| conditions | array | 是 | 查询条件数组 |
| conditions[].name | string | 否 | 姓名(模糊查询) |
| conditions[].mobile | string | 否 | 手机号 |
| conditions[].id_card | string | 否 | 身份证号 |
| conditions[].appid | string | 否 | 应用ID |
请求示例:
POST https://sj.jiaxing98.top/api/sj1/count
Content-Type: application/json
X-App-ID: your_appid
X-App-Key: your_key
{
"conditions": [
{"name": "张三"},
{"mobile": "13800138002"},
{"appid": "your_appid"}
]
}
返回示例:
{
"code": 200,
"message": "批量查询成功",
"data": [
{
"condition": {
"name": "张三",
"mobile": "",
"id_card": "",
"appid": ""
},
"count": 1
},
{
"condition": {
"name": "",
"mobile": "13800138002",
"id_card": "",
"appid": ""
},
"count": 1
},
{
"condition": {
"name": "",
"mobile": "",
"id_card": "",
"appid": "your_appid"
},
"count": 3
}
]
}
说明
- 同一个接口支持两种模式:GET 用于简单统计,POST 用于批量条件查询
- 批量条件查询可以同时查询多组条件的统计结果
- 每个条件中的字段都是可选的,可以组合使用
批量删除数据接口
POST /api/sj1/delete
批量删除数据(只能删除自己appid的数据)
请求方式
POST
请求URL
https://sj.jiaxing98.top/api/sj1/delete
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appid | string | 是 | 应用ID(通过Header或Body传递) |
| key | string | 是 | 应用密钥(通过Header或Body传递) |
| ids | array | 是 | 要删除的数据ID数组 |
请求示例(单个删除)
POST https://sj.jiaxing98.top/api/sj1/delete
Content-Type: application/json
X-App-ID: your_appid
X-App-Key: your_key
{
"ids": [1000001]
}
请求示例(批量删除)
POST https://sj.jiaxing98.top/api/sj1/delete
Content-Type: application/json
X-App-ID: your_appid
X-App-Key: your_key
{
"ids": [1000001, 1000002, 1000003]
}
返回示例(成功)
{
"code": 200,
"message": "批量删除完成",
"data": {
"results": [
{
"id": 1000001,
"status": "成功",
"message": "删除成功"
},
{
"id": 1000002,
"status": "成功",
"message": "删除成功"
},
{
"id": 1000003,
"status": "失败",
"message": "记录不存在或无权删除"
}
],
"success_count": 2,
"fail_count": 1,
"total": 3
}
}
说明
- 支持单个或批量删除,通过 ids 数组传递要删除的ID
- 只能删除属于自己appid的数据,删除其他appid的数据会返回失败
- 删除操作为物理删除,数据将从数据库中永久移除,无法恢复
- 返回结果包含每个ID的删除状态,以及成功/失败的统计信息
- 即使部分ID删除失败,接口也会返回200状态码,需要检查返回的详细结果