App接口文档模板

根据提供的文档内容，我们可以将其中的关键知识点归纳如下： ### 1. 文档目的与范围 文档的主要目的是为了规范和明确**站点APP接口**的具体定义，包括登录、列表信息展示、新增、修改等基本操作的接口定义。这有助于开发团队更好地理解和实现各个功能模块。 ### 2. 接口协议 #### 2.1 物流登陆鉴权接口 (getWwlOrg) - **接口名称**: `getWwlOrg` - **接口使用**: 超级老板Appserver端 - **接口说明**: 用于超级老板APP端的登录操作，并获取物流平台的基本信息。 - **请求消息格式**: - 必填参数: - `appName`: 调用方信息 - `orgId`: 会员店ID - **响应消息格式**: - 结果参数: - `cmd`: 接口名 - `result`: 接收处理结果的代码（0表示成功，非0表示错误） - `note`: 处理结果代码的说明 - `detail`: 接口返回内容明细 - `wwlOrgId`: 对应应用系统管理 > 公司组织 > 公司编码，若为空则超级老板APP中个人中心不显示我的物流模块 #### 2.2 获取运力列表及详细信息 (getTransportList) - **接口名称**: `getTransportList` - **接口使用**: 用户App - **接口说明**: 用于获取运力信息列表及运力详细信息。 - **请求消息格式**: - 必填参数: - `appName`: 调用方信息 - `orgId`: 会员店ID - 可选参数: - `driverId`: 查询单个运力信息时需传入 - `pageNo`: 分页的当前页码，默认为0 - `pageSize`: 分页的每页记录数，默认为10 - **响应消息格式**: - 结果参数: - `cmd`: 接口名 - `result`: 接收处理结果的代码（0表示成功，非0表示错误） - `note`: 处理结果代码的说明 - `records`: 总共记录数，分页用到的 - `pages`: 总共页数，分页用到的 - `pageNo`: 当前第几页 - `details`: 运力信息列表 #### 2.3 新增运力接口 (addTransportInfo) - **接口名称**: `addTransportInfo` - **接口使用**: 超级老板Appserver端 - **接口说明**: 用于新增运力信息。 - **请求消息格式**: - 必填参数: - `appName`: 调用方信息 - `orgId`: 会员店ID - `transportInfo`: 运力信息详情 - **响应消息格式**: - 结果参数: - `cmd`: 接口名 - `result`: 接收处理结果的代码（0表示成功，非0表示错误） - `note`: 处理结果代码的说明 - `detail`: 接口返回内容明细 #### 2.4 修改运力接口 (updateTransportInfo) - **接口名称**: `updateTransportInfo` - **接口使用**: 超级老板Appserver端 - **接口说明**: 用于修改运力信息，如果提交后审核不通过，则运力需要再次修改并重新提交审核。 - **请求消息格式**: - 必填参数: - `appName`: 调用方信息 - `orgId`: 会员店ID - `transportInfo`: 运力信息详情 - **响应消息格式**: - 结果参数: - `cmd`: 接口名 - `result`: 接收处理结果的代码（0表示成功，非0表示错误） - `note`: 处理结果代码的说明 - `detail`: 接口返回内容明细 ### 3. 统一接口调用与返回格式 - **接口调用后返回格式**: - JSON格式 - 参数包括: - `cmd`: 接口名 - `params`: 请求参数 - `result`: 接收处理结果的代码 - `note`: 处理结果代码的说明 - `detail`: 接口返回内容明细 - **接口返回值**: - 成功时返回`0` - 失败时返回非`0`的错误码 以上内容详细地描述了文档中提到的几个关键接口的功能、请求与响应格式，为开发人员提供了清晰的操作指南。