聚合付科技API推送系统

接口文档

1. 文档概述

本接口文档描述了API推送系统的接口规范,包括接口地址、请求参数、响应格式等信息。开发者可以通过本接口将商户信息推送到系统中。

1.1 系统介绍

API推送系统是一个用于接收和管理商户信息的平台,支持通过API接口推送商户数据,并提供后台管理功能进行数据查询和状态管理。

1.2 功能特性

2. 快速开始

2.1 接口地址

主接口地址:https://zn.payjh.cn/api.php

2.2 请求方式

所有接口均使用 POST 方法进行请求。

2.3 数据格式

请求和响应数据均采用 JSON 格式。

2.4 示例请求

POST /API/api.php HTTP/1.1
Host: your-domain.com
Content-Type: application/json

{ "api_key": "your_api_key_here", "merchant_name": "商户全称", "merchant_short": "商户简称", "merchant_account": "merchant001", "agent_name": "代理商名称" }

3. API鉴权

3.1 认证方式

系统采用API Key认证方式,开发者需要在请求体中携带有效的API Key。

3.2 API Key获取

请联系系统管理员获取API Key,或登录后台管理页面在"API Key管理"模块中查看和重置API Key。

3.3 请求体参数

API Key需要作为请求体的一部分传递,具体参数如下:

参数名 类型 必填 描述 api_key String 是 系统分配的API密钥

4. 接口详情

4.1 商户信息推送接口

POST /API/api.php

4.1.1 功能描述

用于推送商户信息到系统中,支持新增和更新操作。

4.1.2 请求参数

参数名 类型 必填 描述 api_key String 是 API密钥,用于身份验证 merchant_name String 是 商户名称 merchant_short String 是 商户简称 merchant_account String 是 商户登录账号 agent_name String 是 所属代理商名称

4.1.3 请求示例

{ "api_key": "your_api_key_here", "merchant_name": "北京科技有限公司", "merchant_short": "科技公司", "merchant_account": "beijing_tech", "agent_name": "北京代理公司" }

4.1.4 响应示例

成功响应
{ "code": 200, "message": "推送成功", "data": { "id": 1, "merchant_name": "北京科技有限公司", "merchant_short": "科技公司", "merchant_account": "beijing_tech", "agent_name": "北京代理公司", "status": "0", "created_at": "2023-05-20 14:30:00", "updated_at": "2023-05-20 14:30:00" } }
失败响应
{ "code": 400, "message": "参数错误", "data": null }

5. 错误代码表

错误代码 描述 处理建议 0 操作成功 请求已成功处理 1 参数错误 检查请求参数是否完整和正确 2 数据库错误 联系系统管理员处理 3 API密钥错误 检查API Key是否正确 4 认证失败 检查认证信息是否正确 200 请求成功 API请求已成功处理

6. 数据字典

6.1 商户信息字段

字段名 类型 描述 示例值 merchant_name String 商户名称 北京科技有限公司 merchant_short String 商户简称 科技公司 merchant_account String 商户登录账号 beijing_tech agent_name String 所属代理商名称 北京代理公司 status String 记录状态(0:未记录,1:已记录) 0 created_at Datetime 推送时间 2023-05-20 14:30:00 updated_at Datetime 更新时间 2023-05-20 14:30:00

7. 开发指南

7.1 开发环境

建议使用以下开发环境:

7.2 调试建议