1. Background

The data flow between the SUNMI store open platform and the Saas provider could be bidirectional and real-time. The Saas provider can pass its data to the open platform and remote control SUNMI’s IOT device.

Meanwhile, SUNMI store open platform could push the data in its system to the saas provider through the data center on their need

２. API specification

2.1 protocol

All Open APIs are HTTPS request with POST method only.

Content-Type	application/x-www-form-urlencoded
data type	JSON
encoding	UTF-8
signature	MD5
sign rule	see chapter 2.2

2.2 Sign rule

See authentication

2.3 Common parameter

parameter	required	type	description
app_id	yes	string	unique identifier provided by SUNMI store open platform
random	yes	string	6-10 digits random string with numbers and alphabets.
timestamp	yes	int	current 10 digit unix timestamp
sign	yes	string	see 2.2

3. Event Monitor APIs

3.1 API list

API address	description
/hook/add	add the HTTP callback address for a set of events
/hook/delete	delete the HTTP callback address for a set of events

3.2 API detail

8.3.1 Add an event monitoring

API description: By requesting this API, User could set up an http callback for a set of events of their choice on the SUNMI store open platform.

When the specified events happened, open platform will request the given HTTP API.

The authorization of this HTTP API must be the same as the SUNMI store open platform API method.

Following parameters must be included in the callback API:

parameter	required	type	description
shop_id	yes	string	the identifier of the shop in open platform
event	yes	int	The type of event to monitor
payload	yes	string	the specific structure of message in JSON

API address: /hook/add

Parameters：

parameter	required	type	description
shop_id	是	string	the identifier of the shop in open platform
http_callback	是	string	the http call back API
event_list	是	array[int]	the list of event to be monitored

return value：

{
  code: 0,
  msg: "succeed",
  data: {
  }
}

parameter event

event value	description
1010	IPC FM010 motion detecting message
1100	add a face to a group result message
2001	IPC real time face recognition message
4100	price change message (currently unavailable)

payload(event=1010):

{
  ipc_id: 029388
  sn: "FS101D8BS00080",
  name: "设备1",
 video_url:"http://xxx.xxx.xxx.xxx/xxx/xxx/41b061f6f10dbd6fe1aaf469fb0ab012d9193d9655816af31cdfbcsdfe71a5fe1",
  model_name: "FM020",
  motion_type: 0,
}

Parameter motion_type:

motion_type value	description
1	motion detection event
2	voice detection event

payload(event=1100):

{
  code: 0,
  msg: "",
  face_id:195
}

Parameter code

code value	description
5527	bad face image
5000	database error

payload(event=2001):

{
    ipc_id: "928",
    face_id: "29195",
    gender: 1,
    age_range: 4，
    group_id: "8927"，
    group_name: "stranger",
    group_type": 2
}

Parameter gender:

gender value	description
0	unknown
1	male
2	female

parameter age_range:

age_range value	description
1	age 0~6
2	age 7~12
3	age 13~18
4	age 19~28
5	age 29~35
6	age 36~45
7	age 46~55
8	age 56~

Parameter group_type

group_type value	description
1	stranger face library
2	familiar face library
3	shop assistant face library
5	custom face library

8.3.2 Cancel event monitoring

API description: By requesting this API, the user can cancel the monitor on given events

API address：/hook/delete