Open Api 接口说明

根据给定文件的信息，我们可以总结出以下关于OpenAPI接口的关键知识点： ### 一、接口概述 **珠海乐图软件有限公司**发布的这份文档介绍了其产品中的一系列OpenAPI接口，主要用于实现用户、角色管理以及表单操作等功能。这些接口旨在简化应用程序间的交互过程，并通过标准化的通信协议提供一系列明确的操作指南。 ### 二、接口分类 #### 1. 登入（POST /openapi/1.0/login） - **功能**：用户认证并获得登录权限。 - **请求方法**：POST - **路径**：`/openapi/1.0/login` #### 2. 登出（GET /openapi/1.0/logout） - **功能**：结束用户的会话。 - **请求方法**：GET - **路径**：`/openapi/1.0/logout` #### 3. 打开表单（GET /openapi/1.0/{模板名称}/{objectId}） - **功能**：获取指定模板下的具体表单信息。 - **请求方法**：GET - **路径**：`/openapi/1.0/{模板名称}/{objectId}` - **参数**：`{模板名称}`表示模板的标识符，`{objectId}`表示特定表单的对象ID。 #### 4. 更新表单（POST /openapi/1.0/{模板名称}/{objectId}） - **功能**：提交或更新指定模板下的具体表单信息。 - **请求方法**：POST - **路径**：`/openapi/1.0/{模板名称}/{objectId}` - **参数**：同上。 #### 5. 打开总表（GET /openapi/1.0/{模板名称}） - **功能**：打开指定模板的总表，用于查看该模板下所有表单的概览信息。 - **请求方法**：GET - **路径**：`/openapi/1.0/{模板名称}` - **参数**：`{模板名称}`表示模板的标识符。 #### 6. 打开总表过滤（POST /openapi/1.0/{模板名称}） - **功能**：打开指定模板的总表，并支持传递过滤条件来筛选数据。 - **请求方法**：POST - **路径**：`/openapi/1.0/{模板名称}` - **参数**：同上。 #### 7. 运行数据规范 - **功能**：执行特定的数据规范查询，支持在模板内或全局范围内执行。 - **请求方法**：GET、POST - **路径**：`/openapi/1.0/{模板名称}/{数据规范名称}/query` 或 `/openapi/1.0/global/{数据规范名称}/query` - **参数**：`{模板名称}`表示模板的标识符，`{数据规范名称}`表示特定的数据规范名称。 #### 8. 用户管理 - **打开用户总表** - **功能**：获取所有用户的列表信息。 - **请求方法**：GET - **路径**：`/openapi/1.0/users` - **打开用户表单列表（带过滤）** - **功能**：获取所有用户的列表信息，并支持传递JSON格式进行分页过滤等操作。 - **请求方法**：POST - **路径**：`/openapi/1.0/users` - **打开用户表单** - **功能**：获取指定用户的详细信息。 - **请求方法**：GET - **路径**：`/openapi/1.0/users/{objectId}` - **更新用户表单** - **功能**：更新指定用户的详细信息。 - **请求方法**：POST - **路径**：`/openapi/1.0/users/{objectId}` #### 9. 角色管理 - **打开角色总表** - **功能**：获取所有角色的列表信息。 - **请求方法**：GET - **路径**：`/openapi/1.0/roles` - **打开角色表单** - **功能**：获取指定角色的详细信息。 - **请求方法**：GET - **路径**：`/openapi/1.0/roles/{objectId}` - **更新角色表单** - **功能**：更新指定角色的详细信息。 - **请求方法**：POST - **路径**：`/openapi/1.0/roles/{objectId}` #### 10. 文件管理 - **上传附件** - **功能**：将文件上传至服务器。 - **请求方法**：POST - **路径**：`/openapi/1.0/{templateName}/file` - **下载附件** - **功能**：从服务器下载指定的文件。 - **请求方法**：GET - **路径**：`/openapi/1.0/{templateName}/file/{objectId}` ### 三、鉴权方式 **2.1 名词解释** - **AppKey**: 由云表平台分配给每个应用空间的唯一标识符，用于生成签名。 - **AppName**: 由云表平台分配给每个应用空间的名称，用户需保密，用于验证签名的有效性。 - **AppId**: 应用空间的唯一ID，由云表平台分配。 - **Sign**: 签名，每次访问服务器时都需要进行签名验证。 - **Timestamp**: 时间戳，每次访问服务器都必须传递当前的时间戳，以确保请求的有效性（通常有效时间为6分钟以内）。 **2.2 签名生成** 签名的生成方式是使用云表平台提供的AppKey与当前访问时间戳进行MD5 32位加密。具体的生成过程为：`Sign = (AppKey + 时间戳) MD5加密转成大写`。 例如： 假设 `AppKey = 058457b7-0e4a-4f6c-b7f`，如果当前的时间戳为 `1234567890`，那么签名的生成过程为：`Sign = (058457b7-0e4a-4f6c-b7f1234567890) MD5加密转成大写`。 通过以上的总结和说明，我们可以清晰地了解到珠海乐图软件有限公司发布的OpenAPI接口的功能、调用方式以及鉴权机制，这将极大地帮助开发者更好地理解和使用这些接口。