附录：API 接口规范

API 接口规范

Mixiot API 接口规范，是 Mixiot 系统对自身应用，以及对外部的接口规范。每个应用都有自己相关的 API，通过这些 API 接口，可以进行该应用的所有事情。

我们以 “客户与项目” 应用，以及接口为例，使用这些 API 接口，同样可以创建客户/项目，以及查看等各种操作，跟我们使用 “客户与项目” 应用完全一样。

Mixiot API 是一个完整的体系，这部分内容将作为附录形式，为 Mixiot 应用手册的阅读者提供参考。

客户与项目API

创建客户/项目

请求参数：

响应参数：

result参数字段：

请求示例

{
    "action": "create_customer",
    "uid": "",
    "name": "mixlinker",
    "description": "无",
    "email": "mix@mixlinker.com",
    "contact": "mix",
    "mobile": "13800138000",
    "phone": "075523746592",
    "province": "广东省",
    "city": "深圳市",
    "address": "",
    "secret": "",
    "responsible": "mix",
    "responsible_phone": ""
}

响应示例：

{
    "resp": "create_customer",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 744,
        "uid": "CST18414161600744",
        "name": "mixlinker",
        "description": "无",
        "email": "mix@mixlinker.com",
        "contact": "mix",
        "mobile": "13800138000",
        "phone": "075523746592",
        "province": "广东省",
        "city": "深圳市",
        "address": "无",
        "secret": "mO3V",
        "responsible": "mix",
        "responsible_phone": "",
        "reference": "",
        "created": "2021-08-24 14:16:16",
        "last_modified": "2021-08-24 14:16:16"
    }
}

更新客户/项目信息

请求参数：

响应参数：

result参数字段：

请求示例：

{
    "action": "update_customer",
    "id": 744,
    "uid": "CST18414161600744",
    "name": "mixlinker",
    "description": "无",
    "email": "mix@mixlinker.com",
    "contact": "mix",
    "mobile": "13800138000",
    "phone": "075523746592",
    "province": "广东省",
    "city": "深圳市",
    "address": "",
    "secret": "",
    "responsible": "mix",
    "responsible_phone": ""
}

响应示例：

{
    "resp": "update_customer",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 744,
        "uid": "CST18414161600744",
        "name": "mixlinker",
        "description": "无",
        "email": "mix@mixlinker.com",
        "contact": "mix",
        "mobile": "13800138000",
        "phone": "075523746592",
        "province": "广东省",
        "city": "深圳市",
        "address": "无",
        "secret": "mO3V",
        "responsible": "mix",
        "responsible_phone": "",
        "reference": "",
        "created": "2021-08-24 14:16:16",
        "last_modified": "2021-08-24 14:16:16"
    }
}

删除客户/项目

请求参数：

响应参数：

result参数字段：

请求示例：

{
    "action": "delete_customer",
    "uid": "CST18414161600744"
}

响应示例：

{
    "resp": "delete_customer",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 744,
        "uid": "CST18414161600744",
        "name": "mixlinker",
        "description": "无",
        "email": "mix@mixlinker.com",
        "contact": "mix",
        "mobile": "13800138000",
        "phone": "075523746592",
        "province": "广东省",
        "city": "深圳市",
        "address": "无",
        "secret": "mO3V",
        "responsible": "mix",
        "responsible_phone": "",
        "reference": "",
        "created": "2021-08-24 14:16:16",
        "last_modified": "2021-08-24 14:16:16"
    }
}

获取客户/项目详情

请求参数：

响应参数：

result参数字段：

请求示例：

{
    "action": "get_customer_item",
    "uid": "CST18414161600744"
}

响应示例：

{
    "resp": "get_customer_item",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "id": 744,
        "uid": "CST18414161600744",
        "name": "mixlinker",
        "description": "无",
        "email": "mix@mixlinker.com",
        "contact": "mix",
        "mobile": "13800138000",
        "phone": "075523746592",
        "province": "广东省",
        "city": "深圳市",
        "address": "无",
        "secret": "mO3V",
        "responsible": "mix",
        "responsible_phone": "",
        "reference": "",
        "created": "2021-08-24 14:16:16",
        "last_modified": "2021-08-24 14:16:16"
    }
}

获取客户/项目列表

请求参数：

响应参数：

result参数字段：

请求示例：

{
    "action": "get_customer_list",
    "page_index": 1,
    "page_size": 1,
    "where_and": [["name","like","%mix%"]],
    "where_or": [["name","like","%%"]]
}

响应示例：

{
    "resp": "get_customer_list",
    "actionid": "",
    "code": 200,
    "msg": "success",
    "info": "success",
    "result": {
        "data": [
            {
                "id": 744,
                "uid": "CST18414161600744",
                "name": "mixlinker",
                "description": "无",
                "email": "mix@mixlinker.com",
                "contact": "mix",
                "mobile": "13800138000",
                "phone": "075523746592",
                "province": "广东省",
                "city": "深圳市",
                "address": "无",
                "secret": "mO3V",
                "responsible": "mix",
                "responsible_phone": "",
                "reference": "",
                "created": "2021-08-24 14:16:16",
                "last_modified": "2021-08-24 14:16:16"
            }
        ],
        "page_index": 1,
        "page_size": 1,
        "total_pages": 1,
        "total_records": 1
    }
}