自助设备完成状态通知
1. 前言:
2. 交互时序图:
3. 请求场景:
智能设备完成制作后通知来伊份
4. 接口要求:
使用来伊份openapi加密协议进行加密请求
5. 接口标准
5.1 基本信息
描述 | 值 |
---|---|
服务名称 | community-card-api |
URL | 测试环境:https://openapi.test.laiyifen.com/community-card-api/community/card/machine/callback 生产环境:https://openapi.laiyifen.com/community-card-api/community/card/machine/callback |
认证方式 | 令牌 |
请求方式 | HTTP(POST) |
功能描述(适用场景) | 线下门店使用用户购买的次卡消费 |
5.2 请求头公共参数 (Header)
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
X-Co-Client | String | 是 | 客户端Id(来伊份提供) |
X-Co-Sign | String | 是 | 签名 |
X-Co-TimeStamp | String | 是 | 签名时间戳 |
5.3 入参 Body
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
orderNo | String | 是 | 订单号(核销接口返回) |
status | Long | 是 | 完成状态:0:未完成,1:完成 |
errorDesc | String | 否 | 未完成原因描述 |
shopCode | String | 是 | 门店编码(来伊份提供) |
mscCode | String | 是 | msc客户端编码(来伊份提供) |
skuCode | String | 是 | 商品编码(来伊份提供) |
saleUnitCode | String | 是 | 商品销售单位(来伊份提供) |
skuQuantity | String | 否 | 商品数量,默认1 |
uniqueCode | String | 是 | 设备唯一编码,长度最大50 |
machineType | String | 是 | 设备类型(1:咖啡机) |
5.4 入参示例
{
"orderNo":"121213121212121212",
"cardPwd":"7FC796CD36154C4",
"shopCode":"107U",
"mscCode":"107U_0006",
"skuCode":"sw10",
"status":1,
"saleUnitCode":"BEI",
"skuQuantity":"1",
"uniqueCode":"123134123123123123123123",
"machineType":"1"
}
5.5 返回统一参数
参数名字 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
code | String | 是 | 返回请求业务代码 |
msg | String | 是 | 返回信息描述 |
data | Json | 是 | 返回参数 |
5.6 返回参数Data
5.7 返回示例
{
"code":"0",
"msg":"success"
}