友朋运营商开放平台
  1. API 列表
友朋运营商开放平台
  • 友朋运营商平台第三方开放平台接口文档
  • 业务场景
    • 场景:自取柜第三方支付业务逻辑
    • 场景:异步通知第三方业务回调地址
    • 场景:自取柜售货机订单同步给第三方
  • API 列表
    • api.test
      POST
    • cabinet.list
      POST
    • cabinet.product.stock
      POST
    • cabinet.open.door
      POST
    • cabinet.order.refund.apply
      POST
    • cabinet.order.user.appeal
      POST
    • cabinet.order.list
      POST
    • cabinet.order.get
      POST
    • consumer.order.list
      POST
    • consumer.order.get
      POST
  1. API 列表

cabinet.list

POST
https://api.yopoint.com/api/gateway/index
使用场景:
查询当前appid(运营商)下的设备清单

请求参数

Header 参数
Content-Type
string 
必需
默认值:
application/x-www-form-urlencoded
Body 参数multipart/form-data
appid
string 
必需
示例值:
{{appid}}
method
string 
必需
示例值:
cabinet.list
biz_content
string 
必需
示例值:
{"Page":1,"PageSize":5}
version
string 
必需
示例值:
1.0.0
timestamp
string 
必需
示例值:
{% mock 'timestamp', 's' %}
sign_type
string 
必需
示例值:
md5

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.yopoint.com/api/gateway/index' \
--form 'appid=""' \
--form 'method="cabinet.list"' \
--form 'biz_content="{\"Page\":1,\"PageSize\":5}"' \
--form 'version="1.0.0"' \
--form 'timestamp="{% mock '\''timestamp'\'', '\''s'\'' %}"' \
--form 'sign_type="md5"'

返回响应

🟢200成功
application/json
Body
error_code
integer 
必需
0代表成功,-1代表签名错误
error_msg
string 
必需
sub_error_code
null 
必需
sub_error_msg
null 
必需
data
object 
必需
total
integer 
设备总数量
必需
per_page
integer 
必需
current_page
integer 
必需
last_page
integer 
必需
from
integer 
必需
to
integer 
必需
data
array [object {15}] 
必需
示例
{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "sub_error_code": null,
    "sub_error_msg": null,
    "data": {
        "total": 24,
        "per_page": 5,
        "current_page": 1,
        "last_page": 5,
        "from": 0,
        "to": 5,
        "data": [
            {
                "id": "65210ef35c5b0100113e61dd",
                "Name": "硬件售后yp3566主控测试",
                "DeviceCode": "196665387327",
                "Code": "196665387327",
                "CargoConfig": [
                    {
                        "Row": 1,
                        "Col": 1,
                        "BarCode": "12517426"
                    },
                    {
                        "Row": 1,
                        "Col": 2,
                        "BarCode": "8801056143015"
                    },
                    {
                        "Row": 1,
                        "Col": 3,
                        "BarCode": "6973890880011"
                    },
                    {
                        "Row": 1,
                        "Col": 4,
                        "BarCode": "9556570105139"
                    },
                    {
                        "Row": 1,
                        "Col": 5,
                        "BarCode": "9555589212142"
                    },
                    {
                        "Row": 1,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 1,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 1,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 3,
                        "BarCode": "12517426"
                    },
                    {
                        "Row": 6,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 8,
                        "BarCode": ""
                    }
                ],
                "SellStatus": 1,
                "OnlineStatus": 0,
                "Province": "广东省",
                "City": "深圳市",
                "District": "宝安区",
                "Address": "宝安区西乡航城智谷·中城未来产业园(航城大道北)",
                "ServicePhone": "",
                "ReplenisherAccountID": "6018f8cd7f5b7300118d7e2c",
                "CabinetCount": 1,
                "Location": [
                    114.00215258093391,
                    22.59496950692113
                ]
            },
            {
                "id": "64ec358a5ae2c90011d74e7a",
                "Name": "硬件售后编号测试主控",
                "DeviceCode": "888888",
                "Code": "193201873143",
                "CargoConfig": [
                    {
                        "Row": 1,
                        "Col": 1,
                        "BarCode": "6970399922112"
                    },
                    {
                        "Row": 1,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 1,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 1,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 1,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 1,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 1,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 1,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 2,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 3,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 4,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 5,
                        "Col": 8,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 1,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 2,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 3,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 4,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 5,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 6,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 7,
                        "BarCode": ""
                    },
                    {
                        "Row": 6,
                        "Col": 8,
                        "BarCode": ""
                    }
                ],
                "SellStatus": 1,
                "OnlineStatus": 0,
                "Province": "广东省",
                "City": "深圳市",
                "District": "宝安区",
                "Address": "宝安区西乡航城智谷·中城未来产业园(航城大道北)",
                "ServicePhone": "",
                "ReplenisherAccountID": "60c1f0b5d590e70011ab0124",
                "CabinetCount": 1,
                "Location": [
                    113.854398,
                    22.612764
                ]
            }
        ]
    }
}
修改于 2024-01-11 05:57:16
上一页
api.test
下一页
cabinet.product.stock
Built with