API Explanation (V2.5)

Source file: Vending Machine Program Integration with Third-Party Software V2.5 new.pdf

Output type: English HTML extract. Non-English content was translated or replaced with the English equivalent already present in the document.

1. Introduction

1.1 Purpose of Writing

This section explains the design considerations of the program system, including the basic processing flow of the program, the organizational structure of the system, module division, function allocation, interface design, and data structure design.

Note: Different users can implement their respective interfaces based on their different needs. If an interface is not relevant, it does not need to be implemented. QR code scanning requires additional hardware installation.

1.2 Terms and Abbreviations

2. Summary Design

All interfaces use HTTP POST to send requests to the third-party server, and the returned results are in JSON format. The request address for the VMC is configurable. See the last page for how to enter the server address.

2.1 Interface Design

2.1.1 Restock: Vending machine reports each slot's data to the third party

2.1.1.1 Request

Any changes to product data on the machine trigger this interface to report to the third-party server.

2.1.1.2 Response

{"Status":"0","SlotNo":"22","TradeNo":"20170802193446876","Err":"success","ImageUrl":"http://xxx.com/201708029502889.png","ImageDetailUrl":"http://xxx.com/20170801124323318.png"}

2.1.2 Verify pick-up code

2.1.2.1 Request

2.1.2.2 Response

{ "Status": "0","SlotNo":"23","ProductID":"1002356","TradeNo":"20170609123523569","Err":"success"}

2.1.3 Poll interface

2.1.3.1 Request

2.1.3.2 Response

Case 1: MsgType = 0. Server controls the VMC to dispense the product.

{ "Status": "0","MsgType":"0","TradeNo":"20170609123523569","SlotNo":"25","ProductID":"1005678692","Err":"success"}

Note: This feature is generally used for app or e-commerce one-click pickup. The VMC should call this interface periodically. Recommended interval: 3 seconds.

Case 2: MsgType = 1. E-commerce platform or app notifies the VMC of restocking.

{ "Status": "0","MsgType":"1","SlotNo":"25","TradeNo":"111111","Capacity":"1","Quantity":"1","ProductID":"111111","Name":"dsff","Price":"2.0","Type":"yinl","Introduction":"ssfsf","ImageUrl":"http://xxx.com/201708029502889.png","ImageDetailUrl":"http://xxx.com/201708029502889.png","GoodsAdUrl":"ssfsf","Err":"success"}

Note: After successful restocking, call the restocking result feedback interface. Since polling happens every 3 seconds, the machine needs time to update product information after receiving the message. The server can wait a while before checking for success or failure feedback. During this wait, the response can still return the content for server-controlled dispensing.

Note: After downloading, call the download result feedback interface. Because polling happens every 3 seconds, the machine needs time to download the advertisement after publication. The server can wait before checking for success/failure feedback. During this wait, it can still return content for server-controlled dispensing. When returning ad content, return all published ads, including ones already downloaded successfully, because the local machine compares against the returned ad list and deletes ads that are no longer present.

2.1.4 Result feedback

2.1.4.1 Product delivery feedback

2.1.4.2 Response

{ "Status": "0","TradeNo":"20170609123523569","SlotNo":"25","Err":"success"}

2.1.4.3 APP restocking result feedback request

2.1.4.4 Response

{ "Status": "0","SlotNo":"25","TradeNo":"20170609123523569","Err":"success"}

3. Android Application Server Address Configuration

3.1 Connect the machine to the network

3.2 Enter settings in the Android program

Go to the machine administration settings page, open E-Commerce pickup, and enter your server address there to receive data.

Note: The original PDF appears to include configuration screenshots on the last pages. Text extraction did not capture the image content.