OpenAPI
本文档用于说明icHub平台所提供的接出服务，即OpenAPI服务的内容。
版本号：V1.0
更新时间：2023/02/26
1.总体说明
icHub的Openapi体系，采用的是GraphQL技术。与传统的restful相比，其最大的优点就是，可以根据自行配置的入参来决定返回的出参。这就为使用统一接口而提供差异化的返回结果提供了可能性。
2.申请流程
在商户-买卖车-接口菜单下点击创建，填写申请表；
商户户主提交后，接口管理员后台审批，完成后审批结果返回后即可开通。
3.请求路径
测试路径：http://test.ichub.cn/api/general/v1/graphql
请求方式：POST
4.入参说明
查询条件
参数名称 | 数据类型 | 是否必须 | 备注 |
current | Int | N | 页码，默认1 |
page_size | Int | N | 每页返回数据条数，默认100 |
start | Long | Y | 开始时间戳，长度13位 |
end | Long | Y | 结束时间戳，长度13位 |
Token | String | Y | 成功调用登录接口生成的口令，必须确定真实有效 |
App-Key | String | Y | 在个人商户下填写接出接口申请单，在管理员审批之后自动生成的秘钥 |
出参可定义字段（GraphQL框架支持用户自定义选择所需的字段，要求最少设定一个出参字段：
参数名称 | 数据类型 | 备注 |
line_number | String | 业务项号 |
part_number | String | 型号名称 |
part_brand | String | 厂牌名称 |
coo | String | 产地 |
packing | String | 包装 |
date_code | String | 批次 |
lead_time | String | 货期 |
description | String | 描述 |
moq | Int | 最小起订量 |
qty | Int | 数量 |
increment | Int | 增量 |
tax_name | String | 税种 |
updated_at | Long | 更新时间，13位时间戳 |
请求示例：
query{
publishList(input:{
page_size:10,
current:1
}){
msg
code
data{
list{
line_number
part_number
part_brand
coo
packing
date_code
lead_time
description
updated_at
moq
increment
qty
tax_name
}
pagination{
current
page_size
total
}
}
}
}
5.出参说明
出参列表：
参数名称 | 数据类型 | 备注 |
line_number | String | 业务项号 |
part_number | String | 型号名称 |
part_brand | String | 厂牌名称 |
coo | String | 产地 |
packing | String | 包装 |
date_code | String | 批次 |
lead_time | String | 货期 |
description | String | 描述 |
moq | Int | 最小起订量 |
qty | Int | 数量 |
increment | Int | 增量 |
tax_name | String | 税种 |
updated_at | Long | 更新时间，13位时间戳 |
成功示例：
{
"data": {
"publishList": {
"code": 200,
"data": {
"list": [
{
"coo": "",
"date_code": "2021年",
"description": "",
"increment": 1,
"lead_time": "14周以上",
"line_number": "A0000002539",
"moq": 1,
"packing": "卷装",
"part_brand": "yfl-yfl",
"part_number": "XM1Z",
"qty": 1000,
"tax_name": "增值税",
"updated_at": 1677033211
},
{
"coo": "",
"date_code": "2022年",
"description": "",
"increment": 1,
"lead_time": "1",
"line_number": "A0000002538",
"moq": 1,
"packing": "",
"part_brand": "SAD",
"part_number": "RC1005FR1",
"qty": 5000,
"tax_name": "增值税",
"updated_at": 1677032675
},
{
"coo": "",
"date_code": "2021年",
"description": "",
"increment": 1,
"lead_time": "14周以上",
"line_number": "A0000002534",
"moq": 1,
"packing": "管装",
"part_brand": "TEST201A_HK",
"part_number": "NMK2012_AS",
"qty": 1000,
"tax_name": "增值税",
"updated_at": 1676972988
}
],
"pagination": {
"current": 1,
"page_size": 3,
"total": 90
}
},
"msg": "操作成功"
}
}}
失败示例：
{
"data": null,
"errors": [
{
"message": "Cannot query field \"qty54\" on type \"PublishModel\". Did you mean \"qty\"?",
"locations": [
{
"line": 21,
"column": 9
}
]
}
]
}
6.在线调试
你可以在在线调试窗口 调试该接口。