GEP提供集成所需API,代理商可使用POST方法向GEP系统发送HTTPS请求并接收对应的响应。下文介绍具体的
请求地址
请求地址格式:https:// {Host} / {Path}
示例:https://member-test-api.gepholding.com/api/user/account/queryUserBalanceAccount
属性 | 描述 |
---|---|
Host | 域名:请求指定环境的服务器域名 测试环境域名:https://member-test-api.gepholding.com 正式环境域名:https://api.gepholding.com |
Path | 请求路径:也即 API 访问路径,从具体 API 的 请求URL 模块获取 示例:/api/user/account/queryUserBalanceAccount |
请求方式:POST
Content-Type:application/x-www-form-urlencoded(文件上传接口需使用:application/data-form)
响应的错误描述errorMsg默认为中文,需要返回英文的话可以在请求头
Header
设置Accept-Language:en-US
请求报文
请求报文参数
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
01. | 版本号 | version | M | String(6) | 1.0.0 |
02. | 证书编号 | certificateId | M | String(19) | GEP提供给商户的证书编号 |
03. | 代理商编号 | agentNo | M | String(19) | GEP提供给代理商的唯一编号 |
04. | 数据类型 | dataType | M | String(8) | JSON |
05. | 加密数据 | dataContent | M | String(2048) | 1.先把 加密数据dataContent 按照dataType 类型组装2. 然后做base64编码后再进行rsa私钥加密,加密方法可参考加密说明 |
06. | 商户号 | userNo | M | String(19) | GEP提供给商户的唯一编号 |
07. | API类型 | apiType | C | String(19) | API类型, 1:代理商请求 2:商户本身请求 该字段为空时默认值为2;该值为1时代理商编号必填 |
08. | 文件 | file | File | C | 文件信息,只有文件上传接口需要,其他接口不需要 文件传输方式可参考demo |
请求报文示例
{
"agentNo": "5182210819000222768",
"certificateId": "2211211448000022579",
"dataType": "JSON",
"version": "1.0.0",
"dataContent": "30efd89292d3cc9bf3cb66f8ff2cbb859bf931c7b26f096e11f53e76fb41918a1d41a61e40a115305547e9c67462565f193de3ceff0e0f052082ce0d363a314f548c37566868fbf2b09aa4b7bdb80e4340dec2c473af6cc95f16418c7791f3c17852ecd342794bbd474c6705cf6db55119aae7deb9011313387fd692d36f2fd0"
}
响应报文
响应报文参数
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
01. | 成功标识 | success | M | String(8) | 返回true、false |
02. | 错误描述 | errorMsg | O | String(512) | 错误描述,success为fasle时不为空,具体见各接口附录错误码 |
03. | 返回结果信息 | result | O | String(2048) | success为false时为空,其他时候不为空,结果信息参考个接口 结果信息result 说明,解密方法参考 解密说明 |
04. | 代理商编号 | agentNo | M | String(19) | GEP提供给商户的唯一编号 |
05. | 证书编号 | certificateId | M | String(19) | GEP提供给商户的证书编号 |
06. | 商户号 | userNo | C | String(19) | GEP提供给商户的唯一编号 |
响应报文示例
成功示例
{ "agentNo": "5182210819000222768", "certificateId": "2211211448000022579", "errorMsg": "受理成功", "result": "5cd975b1419175fa907106ae89acf75448336299f9e6ac01ecc7f1e869a062d93c368824d5b207874316f21f7cc8b5623954b34bff1d15a019a51d55724914d99e654298f62aa5aa582c6282872d3a98653bc1c72cd2b5275da1ea3e7afc5dc835ec9eb817e62161ce216f7f69faae906a54cfb9cc08e62dbdb7151a6d1253b7", "success": true }
失败示例
{ "agentNo": "5182210819000222768", "certificateId": "2211211448000022579", "errorMsg": "邮箱已被使用", "success": false }
作者:陈花枪 创建时间:2024-08-15 10:15
最后编辑:陈花枪 更新时间:2025-04-03 09:53
最后编辑:陈花枪 更新时间:2025-04-03 09:53