API 接口规范

Request

Tip

原则上 【业务接口】统一使用 POST 方式调用，支持大量查询参数的场景

例外：detail 接口使用 GET 方式调用

心跳检测(health) 接口使用 使用 GET方式调用

参数

  • login_user
  • auth
  • params

Response

  • 全局统一返回格式 JSON
{
    "code":10000,
    "data":{
        "标量":322267732559003648,
        "数组":[
            "value1",
            "value2"
        ],
        "对象":{
            "status":true,
            "type":6,
            "notice":"该干啥干啥，和前端约定提示信息呈现方式、可操作按钮"
        },
        "列表数据格式":{
            "total":122,
            "curr_page":7,
            "page_size":20,
            "list":[
                {
                    "arrt1":123.456,
                    "arrt2":"string",
                    "arrt3":true,
                    "status":3
                },
                {
                    "数值":123.456,
                    "str":"字符串",
                    "boolean":true,
                    "status":4
                }
            ]
        }
    },
    "msg":"只提示操作者原因或建议。屏蔽程序内部错误信息(内部错误应给记录日志，不应该暴露出去)"
}

接口日志

数据同步

Danger

原则上推送方在数据更新时，推送可开放给对接放的 所有数据，由接收方选择性覆盖自己的数据

双方各自记录 推送 接收 时的完整数据做日志，方便查验 选择性接收导致的数据不一致
  • 确定数据同步类型 ADD、EDIT、DELETE|CANCEL、COMPLETE

    ADD 全量数据推送 推送放 指定 order、order_detail、order_ext 表，不指定字段，表示推送全量数据，接收方指定各个表接收的字段集合，各自记录日志

    EDIT 可推送全量数据、部分数据，指定表=>推送的字段 区分不同场景的编辑推送，接收方指定支持更新的 表=>字段，控制己方支持更新的字段，各自记录日志(兼容间隔状态推送)

    DELETE CANCEL 类似于 EDIT，可只更新状态标识，也可自定义更新字段

    COMPLETE 推送全量数据，接收方指定己方接收的数据

    首次COMPLETE之后，如果支持修改数据 需要有特定标识来判定是否推送数据