天通_分销_S系列_S3_API文档
- API使用：
l API需要参数
API入口：http://s3api.demo.ttgrasp.com.cn/FxApi/ApiGateway.Gspx
|
参数名称 |
说明 |
|
AppId |
应用程序ID，现在默认传输：A001 |
|
AppSecret |
应用程序Key，现在默认传输：94626B9C-4B74-49F3-98CF-952475E3F027 |
|
Version |
ERP程序版本，1.2 |
|
TimeStamp |
请求时间戳 |
|
Sign |
签名，目前只用于请求绑定时的签名验证，MD5加密content |
|
Token |
身份令牌 |
|
MethodType |
请求方式，POST/GET |
|
ContentType |
HTTP请求类型，application/x-www-form-urlencoded |
|
AESKey |
加密业务参数的key，传输过程中用对方的公钥加密 |
|
UserId |
操作员ID，现在默认传输：2 |
|
Content |
业务参数 |
|
Method |
被调用的方法（规范：注册服务+方法名） |
举例：
- 请求绑定：
|
输入参数 |
值 |
|
AppId |
A001 |
|
AppSecret |
94626B9C-4B74-49F3-98CF-952475E3F027 |
|
Version |
1.2 |
|
TimeStamp |
2019-08-28 14:00:000 |
|
Sign |
74DD72C7F9BCEEB7E66F61D8E922251D |
|
MethodType |
POST |
|
ContentType |
application/x-www-form-urlencoded |
|
UserId |
2 |
|
Content |
{"clientpublickey":"BgIAAACkAABSU0ExAAQAAAEAAQAJhiLn7du5H+n5Cob7Co+Iutgz7zg543bsjH+Uff/0BM8qrN0k0gPRVv7hoJTZMVnBz/rHJwTIUfxNyYtpkEeOC5I584s6MOnjyIgEpIhIeQdt8jQpYU8alkT9va73Ec8AMSYXDkZs6SyXlJ7Km0y1mcG6Qlk7IpOxvrJiE4aWzQ=="} |
|
Method |
FxApi.ApiBinding |
|
输出参数 |
值 |
|
Code |
1 |
|
Msg |
"绑定接口成功！" |
|
AESKey |
需要使用RSA私钥解密得到 |
|
Result |
AES加密的密文，解密后格式： {"serverpublickey":"xxxxxxxxxxxx","appsecret":"xxxxxxxxxxxx"} |
- 分发token：
|
输入参数 |
值 |
|
AppId |
A001 |
|
AppSecret |
bqIhOTU1TMS7LH7xJDQl+MprOlIRCJH+1v26CVhwLt40qwjFlFKjCcd9ovbpRAeLnTa2v8Ou3wu4+TO6wsQbZ70mFvXJVu1yBzwyXQiN8Q8aVzsQFS0Md79squAvxHfmTyrw+DqLJfzb0/Dp6kgI/0OfnlzyiXDUWkj1f9HfBRU= |
|
Version |
1.2 |
|
TimeStamp |
2019-08-28 14:00:000 |
|
MethodType |
POST |
|
ContentType |
application/x-www-form-urlencoded |
|
UserId |
2 |
|
Method |
FxApi.AllocateToken |
|
输出参数 |
值 |
|
Code |
1 |
|
Msg |
"分发Token成功！" |
|
AESKey |
需要使用RSA私钥解密得到 |
|
Result |
AES加密的密文，解密后格式： {"token":"xxxxxxxxxxxx","tokenexpiredate":"xxxxxxxxxxxx"} |
- API CODE:
|
Code |
值 |
描述 |
|
Success |
1 |
成功 |
|
ExceptionError |
2 |
发生异常 |
|
AppIdError |
3 |
应用程序ID错误，身份验证失败 |
|
AppSecretError |
4 |
身份验证失败（应用程序Key不匹配） |
|
TokenError |
5 |
身份令牌token错误 |
|
SignValidateFailed |
6 |
签名验证失败 |
|
ContentTypeError |
7 |
HTTP请求Content-Type错误 |
|
VersionIsEmpty |
8 |
版本缺失 |
|
TimeStampIsEmpty |
9 |
时间戳缺失 |
|
ApiMethodIsEmpty |
10 |
请求的Api方法缺失 |
|
ParseApiMethodFailed |
11 |
解析Api方法失败 |
|
ApiMethodNotExists |
12 |
请求的Api方法不存在 |
|
ApiMethodParameterError |
13 |
业务参数缺失或者解析参数失败 |
|
MethodTypeError |
14 |
HTTP请求错误 |
|
ExecuteFailed |
15 |
调用接口方法执行失败 |
|
ContentIsEmpty |
16 |
请求业务参数缺失 |
|
SignIsEmpty |
17 |
签名缺失 |
|
TimeStampFormatError |
18 |
时间戳格式不正确 |
|
AppIdIsEmpty |
19 |
应用程序ID缺失 |
|
AppSecretIsEmpty |
20 |
应用程序Key缺失 |
|
TokenIsEmpty |
21 |
身份令牌缺失 |
|
ApiBindingException |
22 |
绑定接口异常 |
|
AllocateTokenException |
23 |
分发Token异常 |
|
RefreshTokenException |
24 |
刷新Token异常 |
|
TokenExpired |
25 |
Token过期 |
销售出库单：
（FxApi.SaleBill.Save）保存：
|
返回code |
返回msg |
调用方法路径 |
|
MsgType.WithRecode |
"【{0}】单据编号重复，不能保存过账。是否由系统自动生成新的单据编号？" |
GetBillCode之后调用save方法 |
|
MsgType.WithMinDiscountConfirm |
"该商品折扣小于折扣下限！" |
无交互，只是弹页面提示 |
|
MsgType.WithBillConfirm |
售价、成本价、最近进价控制等 |
点确定后调用save方法 |
|
MsgType.WithAlarmStock |
库存上下限 |
点确定后调用save方法 |
|
MsgType.WithVirtualStockConfirm |
虚拟库存 |
点确定后调用save方法 |
|
MsgType.WithBillConfirm |
信用额度 |
点确定后调用save方法 |
（FxApi.SaleBill.Pass）过账（包括save的验证）：
|
返回code |
返回msg |
调用方法路径 |
|
MsgType.WithRecode |
"【{0}】单据编号重复，不能保存过账。是否由系统自动生成新的单据编号？" |
GetBillCode之后调用save方法 |
|
MsgType.WithMinDiscountConfirm |
"该商品折扣小于折扣下限！" |
无交互，只是弹页面提示 |
|
MsgType.WithBillConfirm |
售价、成本价、最近进价控制等 |
点确定后调用save方法 |
|
MsgType.WithAlarmStock |
库存上下限 |
点确定后调用save方法 |
|
MsgType.WithVirtualStockConfirm |
虚拟库存 |
点确定后调用save方法 |
|
MsgType.WithBillConfirm |
信用额度 |
点确定后调用save方法 |
|
MsgType.WithCostPriceInput |
零成本控制 |
页面input之后调用save方法 |
API-20190905业务参数列表
