获取产品列表

接口不做缓存处理，若有特殊场景: 秒杀、同设备多单抢购等可以定制。

TIP

请求接口(Header)必须携带参数，Appid、AppSecret

请求方式(METHOD): POST
请求路径(URL): {url}/api/openapi/v1/products
请求参数(Argsments): payload: base64code

Payload

参数	类型	说明	必传
machine_no	string	设备编号(定长 8 位数字字符串)	✓
page	string	分页, 默认: 1	✓
per_page	string	分页大小, 默认: 10	-
category_id	string	商品分类, 默认: 0, 即查所有	-
cabinet_name	string	柜号, 默认: A, 取值范围 [A-Z] (v1.13.0 新增)	-
select_all	string	查询所有, 取值范围: ["0", "1"], 默认: "0"	-
addr	string	从机地址, 如: "1", 即第一块驱动器, 取值范围 ["1"-"8"] (v1.25.0 新增)	-
timestamp	string	当前时间戳	✓

cabinet_name, addr 不可同时传参

参数加密

对接示例

我们为您提供了 2 种语言 GO,PHP 的对接示例，如果您需要其他语言示例，请 联系我们。

TIP

{url}默认为提供服务的地址

GO

package main

import (
 "fmt"
 "io"
 "net/http"
)

func main() {
    json := []byte(`{"payload": "eyJjYXRlZ29yeV9pZCI6MSwibWFjaGluZV*****iLCJwYWdlIjoxLCJwZXJfcGFnZSI6MTAsInNpZ24iOiIyMTlDMTZCREY0MkQzNjY4RkY1Qjg1QTMwRkU5N0Y1NCIsInRpbWVzdGFtcCI6IjE3MTMyNTU0MTEifQ=="}`)
 body := bytes.NewBuffer(json)

 // Create client
 client := &http.Client{}

 // Create request
 req, err := http.NewRequest("POST", "{url}/api/openapi/v1/products", body)

 // Headers
 req.Header.Add("Appid", "ds*******")
 req.Header.Add("AppSecret", "********")

 parseFormErr := req.ParseForm()
 if parseFormErr != nil {
   fmt.Println(parseFormErr)
 }

 // Fetch Request
 resp, err := client.Do(req)

 if err != nil {
  fmt.Println("Failure : ", err)
 }

 // Read Response Body
 respBody, _ := io.ReadAll(resp.Body)

 // Display Results
 fmt.Println("response Status : ", resp.Status)
 fmt.Println("response Headers : ", resp.Header)
 fmt.Println("response Body : ", string(respBody))
}

PHP

<?php

// Include Guzzle. If using Composer:
// require 'vendor/autoload.php';

use GuzzleHttp\Pool;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client();

$request = new Request(
        "POST",
        "{url}/api/openapi/v1/products",
        [
            "Appid" => "ds*******************",
            "AppSecret" => "*******************",
        ],
        "{\"payload\":\"eyJjYXRlZ29yeV9pZCI6MSwibWFjaGluZV9ubyI6Ijg2NjgzODA2MjUzNzU0OTIiLCJwYWdlIjoxLCJwZXJ*****sInRpbWVzdGFtcCI6IjE3MTMyNTU0MTEifQ==\"}");

$response = $client->send($request);
echo "Response HTTP : " . $response->getStatusCode();

请求结果(成功)

将以上 Appid、AppSecret 进行修改成您商户的内容，运行结果:

{
  "code": 0,
  "message": "ok",
  "data": {
    "data": [
      {
        "id": 20,
        "category": {
          "id": 2,
          "title": "第二层"
        },
        "good": {
          "name": "可乐",
          "description": "可乐",
          "thumb": "{url}/storage/BkGv6Ij4Am/80b306a1-52db-4694-8de9-45181cc590be.png",
          "price": "0.10",
          "original_price": "0.00",
          "content": "<p>可口可乐</p>",
          "good_no": "412883701240",
          "slug": "412883701240"
        },
        "channel": {
          "name": "A21",
          "cabinet_name": "A",
          "code": "020",
          "x": "2",
          "y": "0",
          "addr": 1
        },
        "current_inventory": 1,
        "inventory": 2
      }
    ],
    "total": 6,
    "current_page": 1,
    "last_page": 1,
    "per_page": 10
  }
}

TIP

注意: 因接口返回的字段使用 protobuf, 部分字段值为空 或 false 时，默认不传

参数	类型	说明	必传
data	object	产品内容	✓
total	int	总记录数	✓
current_page	int	当前页码	✓
last_page	int	最后一页	✓
per_page	int	分页数	✓

查询结果为空时，data 默认返回空数组

{
  "code": 0,
  "message": "ok",
  "data": []
}

商品项说明

{
  "id": 20,
  "category": {
    "id": 2,
    "title": "第二层"
  },
  "good": {
    "name": "可乐",
    "description": "可乐",
    "thumb": "{url}/storage/BkGv6Ij4Am/80b306a1-52db-4694-8de9-45181cc590be.png",
    "price": "0.10",
    "original_price": "0.00",
    "content": "<p>可口可乐</p>",
    "good_no": "412883701240",
    "slug": "412883701240"
  },
  "channel": {
    "name": "A21",
    "cabinet_name": "A",
    "code": "020",
    "x": "2",
    "y": "0",
    "addr": 1
  },
  "current_inventory": 1,
  "inventory": 2
}

参数		类型	说明	必传
id		int	产品ID	✓
current_inventory		int	当前库存	✓
inventory		int	最大库存	✓
category	-	object	商品分类	✓
	id	int	分类ID	✓
	title	string	分类名称	✓
good	-	object	商品内容	✓
	name	string	名称	✓
	description	string	介绍	✓
	thumb	string	封面	✓
	price	string	价格	✓
	original_price	string	原价	✓
	content	string	富文本内容	✓
	good_no	string	商品编码	✓
	slug	string	商品编码 v1.2.3 新增字段	✓
media	array	图片轮播图	-
channel	-	object	货道信息	✓
	name	string	货道名	✓
	cabinet_name	string	柜号	✓
	code	string	电机号, 默认从000开始，即第一行第一列; 200, 为副柜第一行第一列	✓
	x	string	行, 默认从0开始，即第一行	✓
	y	string	列, 默认从0开始，即第一列	✓
	addr	int	从机地址, 默认从1开始，即第一个驱动板	✓

请求结果(失败)

根据返回的 错误代码 进行排查:

{
  "code": 30002,
  "message": "设备已离线",
  "data": {}
}