# 草料开放平台 > 草料开放平台是草料二维码官方提供的开放接入服务:通过 MCP 让 AI 助手生成二维码、搭建表单、查询数据;通过 API 把二维码、表单和记录接入业务系统;或把数据同步到数据库和 BI。每个页面都可在地址后把 .html 换成 .md 获取 Markdown 原文。 ## 服务地址 - 管理端 MCP(需 OAuth 授权组织,生成二维码、搭建表单、查询数据):https://open.cli.im/mcp ,连接器名 caoliao-admin - 扫码端 MCP(免登录,读取单个二维码的公开内容):https://mcp.objqr.com/mcp ,连接器名 caoliao-scan - A2A(免鉴权,只读):https://a2a.objqr.com - OAuth 授权服务器:https://oauth.cli.im ,元数据 https://oauth.cli.im/.well-known/oauth-authorization-server - V2 REST:https://open.cli.im/api/v2/rpc/ ,使用个人 API Key 或 OAuth 鉴权;接口规范 https://open.cli.im/openapi.json - 二维码图片工具(免鉴权):https://api.2dcode.biz/v1/ - 标签生成 API:https://open-api.cli.im/cli-open-platform-service/v1/ - 全部官方地址与名称:https://cli.im/open-api/start/official-endpoints.md - [全文](https://cli.im/open-api/llms-full.txt) ## 开始 - [草料开放平台](https://cli.im/open-api/index.md): 草料开放平台是草料二维码官方提供的开放接入服务,提供 MCP、数据 API 与同步、二维码及标签制作 API、第三方应用集成四类接入方式,让 AI 助手、业务系统和办公软件使用草料二维码的二维码管理、表单、数据记录和统计等能力。 - [接入方式](https://cli.im/open-api/start/choose.md): 草料开放平台的各种接入方式:管理端 MCP、扫码端 MCP、A2A、API、Webhook 推送、数据库直连、二维码图片工具、标签生成 API 和第三方应用集成分别适合做什么、需要准备什么,以及几组常见接入方式怎么选。 - [核心概念](https://cli.im/open-api/start/concepts.md): 接入草料开放平台前需要了解的五个对象:二维码、批量模板与子码、表单与记录、分区、组织,它们之间的关系,以及在接口里用哪个参数标识。 - [额度、版本与收费](https://cli.im/open-api/start/quota-and-pricing.md): 草料开放平台各项能力的接入方式、收费和额度:管理端 MCP、扫码端 MCP、A2A、V2 REST、二维码图片工具、标签生成 API、数据同步和第三方应用集成,以及调用额度怎么查、超额后怎么办。 - [官方服务地址与名称](https://cli.im/open-api/start/official-endpoints.md): 草料开放平台的官方服务地址(管理端 MCP、扫码端 MCP、A2A、V2 REST、二维码图片工具、标签生成 API)、二维码链接域名、连接器和 Skill 名称,以及官方 GitHub 仓库。 ## AI 接入(MCP) - [AI 接入:概览与选型](https://cli.im/open-api/agent/overview.md): 草料二维码提供两套 MCP 服务:管理端 MCP(open.cli.im/mcp)需要 OAuth 授权组织,可以生成二维码、搭建表单和查数据;扫码端 MCP 和 A2A 不用登录,只读一个二维码的公开内容。 - [管理端 MCP 快速开始](https://cli.im/open-api/agent/open-platform-mcp/quick-start.md): 在 WorkBuddy、千问办公、豆包工作等办公 AI 中连接草料二维码管理端 MCP:复制安装提示词让 AI 完成连接、OAuth 授权和 Skill 安装,或按三步手动接入。 - [在 WorkBuddy 中使用草料二维码MCP](https://cli.im/open-api/agent/open-platform-mcp/workbuddy.md): 在腾讯 WorkBuddy 中安装草料二维码连接器:在「专家·技能·连接器」→「连接器」里搜索安装,或打开安装链接;OAuth 授权、AI 安装 Skill 与首次使用,也可手动添加。 - [在千问办公中使用草料二维码MCP](https://cli.im/open-api/agent/open-platform-mcp/qwen-work.md): 在千问办公(QwenWork)的应用市场安装草料二维码连接器:搜索启用、OAuth 授权、AI 安装 Skill 与首次使用;也可手动添加。 - [在豆包工作中使用草料二维码MCP](https://cli.im/open-api/agent/open-platform-mcp/doubao-work.md): 在豆包工作中接入草料二维码管理端 MCP 的步骤:手动配置 MCP、OAuth 授权、AI 安装 Skill 与首次使用。 - [在 DeepSeek Harness 中使用草料二维码MCP](https://cli.im/open-api/agent/open-platform-mcp/deepseek-harness.md): 在 DeepSeek Harness 中安装草料二维码插件,通过账号授权连接 MCP,使用内置 Skill 生成二维码、查看表单记录和分析巡检数据。 - [管理端 MCP:其他客户端与开发者接入](https://cli.im/open-api/agent/open-platform-mcp.md): 草料二维码管理端 MCP 在 Claude、Claude Code、Cursor、VS Code 等客户端里的配置方法,以及开发者需要的服务地址、OAuth 授权机制(动态注册、PKCE、设备码)、scope 说明、撤销与常见失败排查。 - [管理端 MCP 工具列表](https://cli.im/open-api/agent/open-platform-mcp/tools.md): 草料二维码管理端 MCP 工具列表:按任务分组的查询和写入工具、可用范围与错误处理。 - [安装草料二维码管理端 MCP Skill](https://cli.im/open-api/agent/open-platform-mcp/skill.md): 连接草料二维码管理端 MCP 并完成 OAuth 授权后,复制提示词给 AI,安装配套的 caoliao-admin Skill。 - [扫码端 MCP 快速开始](https://cli.im/open-api/agent/public-mcp/quick-start.md): 草料二维码扫码端 MCP 快速开始:免鉴权服务地址、客户端配置方法,以及用 curl 直接验证。 - [扫码端 MCP 工具列表](https://cli.im/open-api/agent/public-mcp/tools.md): 草料二维码扫码端 MCP 的 5 个只读工具:entity_get、entity_records_list、entity_actions_list、entity_action_get、entity_bindings_list 的参数、返回与调用顺序。 - [扫码端 MCP 数据范围](https://cli.im/open-api/agent/public-mcp/data-scope.md): 草料二维码扫码端 MCP 的数据范围:不需要鉴权,只读取扫码可见的公开内容;非公开数据怎么读、只读契约、缓存延迟与跨组织限制。 - [A2A 接入与发现](https://cli.im/open-api/agent/a2a/quick-start.md): 草料二维码 A2A 接入与发现:服务信息、一次完整的 message/send 调用、Agent Card 的三个发现地址与字段含义、只读契约扩展。 - [A2A 服务能力与返回结构](https://cli.im/open-api/agent/a2a/skills.md): 草料二维码 A2A 的三项只读服务能力 get_entity、get_records、list_actions,以及 Task 结构、回查、失败处理与已知限制。 ## API 参考 - [API 概述](https://cli.im/open-api/openapi/v2/overview.md): 草料开放平台 API 概述:基址与调用约定、openapi.json 地址、和 MCP 的分工、第一次调用示例及接口索引。 - [API 鉴权](https://cli.im/open-api/openapi/v2/auth.md): 草料开放平台 API 鉴权:个人 API Key 创建、验证与撤销指南,以及超级管理员设置组织最高权限和高级成员创建资格的操作步骤。 - [API 错误码与调用额度](https://cli.im/open-api/openapi/v2/error-codes.md): 草料开放平台 API 的调用额度和错误码:V2 REST 与管理端 MCP 按组织共用额度、用 usage/get 查询用量、HTTP 429 的处理,以及通用 code 和业务错误 error_code(100300 ~ 100329)。 - [API 业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md): 草料开放平台 V2 接口的业务错误码清单:每个错误码的 HTTP 状态、含义和处理方式。 - [API 接口清单](https://cli.im/open-api/openapi/v2/api-index.md): 草料开放平台 V2 全部接口清单:按业务分组列出每个接口的路径、需要的最低权限档位,以及历史组织 Key 能否调用。 - [码、模板与表单管理接口](https://cli.im/open-api/openapi/v2/management.md): 草料开放平台 V2 管理接口:用个人 API Key 生成二维码、维护模板和表单、预览并执行删除、导出标签,按任务列出接口路径。 - [API 典型场景](https://cli.im/open-api/openapi/v2/scenarios/overview.md): 草料开放平台 API 典型场景:查询二维码关联的表单和记录、提交记录、Excel 批量新增记录、按模板批量生成二维码、修改和删除、导出标签的调用顺序。 - [查询二维码关联表单和记录](https://cli.im/open-api/openapi/v2/scenarios/query-qrcode-records.md): 草料开放平台 API 典型场景:查询二维码关联的表单与记录,说明推荐调用顺序与关键 ID。 - [向某个二维码的表单提交记录](https://cli.im/open-api/openapi/v2/scenarios/add-record-by-qrcode.md): 草料开放平台 API 典型场景:向指定二维码下的表单提交记录,说明推荐调用顺序与字段准备方式。 - [Excel 批量新增记录(需逐行调用)](https://cli.im/open-api/openapi/v2/scenarios/bulk-import-records.md): 草料开放平台 API 典型场景:把 Excel 数据写成表单记录。API 没有批量导入接口,需要在本地解析 Excel 后逐行调用添加记录接口。 - [按模板批量生成二维码](https://cli.im/open-api/openapi/v2/scenarios/batch-create-qrcodes.md): 草料开放平台 API 典型场景:用个人 API Key 按批量模板批量生成二维码,包含上传图片附件、预校验、提交任务、轮询和逐项核对结果的完整调用顺序。 - [修改和删除二维码、表单](https://cli.im/open-api/openapi/v2/scenarios/edit-and-delete.md): 草料开放平台 API 典型场景:修改和删除已有的二维码与表单。修改前读取版本,删除前预览并凭确认令牌执行,以及各权限档位能改什么。 - [导出可打印的标签](https://cli.im/open-api/openapi/v2/scenarios/export-labels.md): 草料开放平台 API 典型场景:按二维码当前的标签样式预览并导出可打印的标签文件,包含读取配置、预览、创建导出任务和取下载地址的调用顺序。 - [活码列表](https://cli.im/open-api/openapi/v2/api/qrcodes-list.md): 草料开放平台 API 活码列表接口 qrcodes/list,分页获取组织下的活码名称与 coding,支持按时间过滤。 - [活码内容](https://cli.im/open-api/openapi/v2/api/qrcodes-get-content.md): 草料开放平台 API 活码内容接口,根据活码 coding 或 URL 获取展示内容(元信息与字段列表),支持 json 或 markdown 格式。 - [活码关联操作项列表](https://cli.im/open-api/openapi/v2/api/qrcodes-get-operation.md): 草料开放平台 API 活码关联操作项列表接口,根据活码 coding 或 URL 获取关联的操作项元素列表,返回扁平化的操作项元素数据,便于按元素类型直接处理。 - [批量模板列表](https://cli.im/open-api/openapi/v2/api/templates/templates-list.md): 草料开放平台 API 批量模板列表接口 templates/list,分页获取组织下的批量模板,返回模板 ID、名称与批量模板 coding。 - [批量模板结构](https://cli.im/open-api/openapi/v2/api/templates/templates-get.md): 草料开放平台 API 批量模板结构接口 templates/get,根据批量模板获取批量模板的元信息与字段结构(字段 ID、类型、标题、默认值)。 - [模板下子码列表](https://cli.im/open-api/openapi/v2/api/templates/templates-list-qrcodes.md): 草料开放平台 API 模板下子码列表接口 templates/listQrcodes,分页获取某个批量模板下的子码名称、ID 与 coding。 - [子码内容](https://cli.im/open-api/openapi/v2/api/templates/templates-get-subcode.md): 草料开放平台 API 子码内容接口 templates/getSubcode,读取批量模板下某个子码的元信息与各字段的实际内容。 - [创建子码(v1)](https://cli.im/open-api/openapi/api/template-qrcodes/create-qrcode.md): 草料二维码 API 的创建子码接口(v1),在指定批量模板下创建子码。当前版本没有一一对应的替代,继续可用;新项目可先看 V2 管理接口的批量生成 qrcodes/createBatch,字段和流程与 v1 不同。 - [编辑子码(v1)](https://cli.im/open-api/openapi/api/template-qrcodes/edit-qrcode.md): 草料二维码 API 的编辑子码接口(v1),修改子码内容。当前版本没有一一对应的替代,继续可用;新项目可先看 V2 管理接口的修改子码 qrcodeChildren/edit,字段和流程与 v1 不同。 - [删除子码(v1)](https://cli.im/open-api/openapi/api/template-qrcodes/delete-qrcode.md): 草料二维码 API 的删除子码接口(v1),删除子码。当前版本没有一一对应的替代,继续可用;新项目可先看 V2 管理接口的删除 qrcodes/delete,字段和流程与 v1 不同。 - [获取表单列表](https://cli.im/open-api/openapi/v2/api/record/record-get-form-list.md): 草料开放平台 API 获取表单列表接口,支持按标题、备注、编号模糊搜索与按编号精确查询,返回表单列表及分页信息。 - [获取表单结构](https://cli.im/open-api/openapi/v2/api/record/forms-get-template.md): 草料开放平台 API 获取表单结构接口,根据表单模板 ID(tpl_id)获取表单完整结构定义,返回表单基础信息、分组、字段配置、审批流程、处理状态和填写规则。 - [表单组件类型总览](https://cli.im/open-api/openapi/v2/api/record/components-field-types.md): 草料开放平台 API 表单组件类型总览,统一说明 field_type 的名称、分类、共性语义与命名约定,并指向表单结构 API 和记录详情 API 的配置侧和值侧说明。 - [获取单条记录](https://cli.im/open-api/openapi/v2/api/record/record-get-record.md): 草料开放平台 API 获取单条记录接口,根据 record_id 或 record_url 获取记录详情,支持 json、json-ld、markdown 三种输出格式,并提供脱敏后的完整示例与 schema 文件。 - [获取记录列表](https://cli.im/open-api/openapi/v2/api/record/record-get-records.md): 草料开放平台 API 获取记录列表接口,支持按 filters、关键字、时间和分页查询记录;列表中每条记录的内容结构与获取单条记录接口在相同 format 下保持一致,并提供配套示例与 manifest。 - [添加记录](https://cli.im/open-api/openapi/v2/api/record/record-add-record.md): 草料开放平台 API 添加记录接口,向指定二维码与表单模板提交一条记录,支持按 field_type 构造 fields 输入;请求身份由鉴权上下文自动带出,当前暂不支持提交静态资源类组件内容,且 API 来源写入不按表单组件必填校验。 - [核销记录凭证](https://cli.im/open-api/openapi/v2/api/record/certificates-verify.md): 草料开放平台 API 凭证核销接口,对凭证类记录执行核销操作,支持推进到下一状态或设置为指定状态,并可按表单或二维码范围限制核销对象。 - [指标目录](https://cli.im/open-api/openapi/v2/api/metrics/metrics-list.md): 草料开放平台 API 指标目录接口 metrics/list,一次返回组织的业务对象目录(表单、分区、活码、周期计划)与当前可计算的指标清单,是数据分析类调用的入口。 - [指标定义](https://cli.im/open-api/openapi/v2/api/metrics/metrics-get.md): 草料开放平台 API 指标定义接口 metrics/get,返回某个指标的完整定义:统计口径、返回形态、可用分组维度与注意事项。 - [按指标出数](https://cli.im/open-api/openapi/v2/api/metrics/metrics-query.md): 草料开放平台 API 按指标出数接口 metrics/query,回答数量、占比、分布类问题,支持按表单、分区、活码、日、月等维度分组,每个分组自带可复现的下钻条件。 - [检索记录行摘要](https://cli.im/open-api/openapi/v2/api/record/record-search-records.md): 草料开放平台 API 检索记录行摘要接口 record/searchRecords,按多维条件检索记录摘要(含字段名与值),承接 metrics/query 的下钻条件,从统计数字直达具体记录。 - [分区列表](https://cli.im/open-api/openapi/v2/api/projects-list.md): 草料开放平台 API 分区列表接口 projects/list,获取组织下的分区(project)名单,分区是活码与记录的归属维度,可用于统计分组与范围过滤。 - [批量新增或编辑成员(v1)](https://cli.im/open-api/openapi/api/member/add-member.md): 草料二维码 API 的批量新增或编辑成员接口(v1)。当前版本还没有替代接口,这个接口继续可用。 - [查询当前凭证的组织、权限和可用操作](https://cli.im/open-api/openapi/v2/reference/auth_get_context.md): 草料开放平台 V2 接口 auth/getContext:返回当前凭证所属的组织、scope、档位(access_level)和各操作是否可用。 - [查询当前组织的当日额度](https://cli.im/open-api/openapi/v2/reference/usage_get.md): 草料开放平台 V2 接口 usage/get:查询当前组织接口调用的当日额度(按北京时间自然日,API 与 MCP 连接共用):建码、表单和模板、上传素材各自的 used、reserved、remaining,以及频率上限。 - [分页读取填写记录的后续动态](https://cli.im/open-api/openapi/v2/reference/record_activities_list.md): 草料开放平台 V2 接口 record/getActivities:分页读取一条填写记录提交之后的动态(回复、处理进度变化等),只读,不会标记已读。 - [浏览官方模板库的场景和行业分类](https://cli.im/open-api/openapi/v2/reference/gallery_categories.md): 草料开放平台 V2 接口 gallery/categories:浏览官方模板库的系统场景和行业分类,返回 category_id 及 children 层级。 - [搜索官方模板库](https://cli.im/open-api/openapi/v2/reference/gallery_list.md): 草料开放平台 V2 接口 gallery/list:搜索官方模板库:keyword 匹配名称或描述,category_id 限定分类及其子分类,两者至少提供一个。 - [读取官方模板详情](https://cli.im/open-api/openapi/v2/reference/gallery_get.md): 草料开放平台 V2 接口 gallery/get:读取官方模板详情:用途、creation_schema 可填写字段、保留的组件和 compatibility 限制。 - [准备官方模板建码方案](https://cli.im/open-api/openapi/v2/reference/gallery_prepare_creation.md): 草料开放平台 V2 接口 gallery/prepare-creation:用官方模板准备批量建码方案:items 按 gallery/get 的 creation_schema 字段 ID 填写,compatibility.can_add_fields 为 true 时可用 extra_field - [用官方模板生成单个码](https://cli.im/open-api/openapi/v2/reference/gallery_create_qrcode.md): 草料开放平台 V2 接口 gallery/create-qrcode:用官方模板生成单个码:码内容、表单和状态按模板原样安装,不填逐码数据,仅 compatibility.can_create_single 为 true 的模板可用。 - [执行官方模板建码方案](https://cli.im/open-api/openapi/v2/reference/gallery_create_from_plan.md): 草料开放平台 V2 接口 gallery/create-from-plan:执行 gallery/prepare-creation 准备好的方案:后台安装模板并批量创建子码。 - [批量建码预校验,不创建码](https://cli.im/open-api/openapi/v2/reference/qrcodes_prevalidate.md): 草料开放平台 V2 接口 qrcodes/prevalidate:校验已有模板的批量建码数据(最多 100 行),不创建码。 - [提交批量建码任务](https://cli.im/open-api/openapi/v2/reference/qrcodes_create_batch.md): 草料开放平台 V2 接口 qrcodes/createBatch:提交批量建码任务,需要幂等键 idempotency_key。 - [查询建码任务进度](https://cli.im/open-api/openapi/v2/reference/qrcode_tasks_get.md): 草料开放平台 V2 接口 qrcodeTasks/get:查询批量建码任务的整体 status、progress 和 total,按 poll_after_seconds 轮询。 - [查询当前可用于新建的分区或目录](https://cli.im/open-api/openapi/v2/reference/qrcodes_list_create_targets.md): 草料开放平台 V2 接口 qrcodes/listCreateTargets:查询新建时可用的分区和目录:先传 kind=projects,再用返回的 project_id 查 kind=categories。 - [分页读取批量建码逐项结果](https://cli.im/open-api/openapi/v2/reference/qrcode_tasks_get_results.md): 草料开放平台 V2 接口 qrcodeTasks/getResults:按输入顺序分页返回批量建码每一项的结果:item_key 对应的码 ID、coding、web_url 和实际字段值。 - [创建普通图文码并绑定表单](https://cli.im/open-api/openapi/v2/reference/qrcodes_create.md): 草料开放平台 V2 接口 qrcodes/create:创建普通码或图文展示码:components 支持富文本、图片、图集、文件和按钮,可通过 forms 绑定已有表单。 - [创建网址跳转码](https://cli.im/open-api/openapi/v2/reference/qrcodes_create_url_jump.md): 草料开放平台 V2 接口 qrcodes/createUrlJump:创建网址跳转码(活码):扫码直接打开 url,之后可以修改跳转地址并保留扫码统计。 - [创建网址聚合码](https://cli.im/open-api/openapi/v2/reference/qrcodes_create_multi_url.md): 草料开放平台 V2 接口 qrcodes/createMultiUrl:创建网址聚合码(活码):扫码打开链接清单页,按 links 顺序列出 1 到 100 个带标题的网址。 - [创建文本或网址静态码](https://cli.im/open-api/openapi/v2/reference/static_qrcodes_create.md): 草料开放平台 V2 接口 staticQrcodes/create:创建静态码:content 直接编码进二维码,创建后不能修改,没有扫码统计,不能绑定表单。 - [修改码之前读取当前内容、版本和是否可改](https://cli.im/open-api/openapi/v2/reference/qrcodes_get_edit_state.md): 草料开放平台 V2 接口 qrcodes/getEditState:修改码之前先调用:返回 kind(plain/url_jump/multi_url/child)、当前内容、version、editable 和 reason。 - [修改普通码或图文展示码](https://cli.im/open-api/openapi/v2/reference/qrcodes_edit.md): 草料开放平台 V2 接口 qrcodes/edit:修改普通码或图文展示码。 - [修改网址跳转码的名称或跳转地址](https://cli.im/open-api/openapi/v2/reference/qrcodes_edit_url_jump.md): 草料开放平台 V2 接口 qrcodes/editUrlJump:修改网址跳转码的名称或跳转地址; - [修改网址聚合码的名称或链接清单](https://cli.im/open-api/openapi/v2/reference/qrcodes_edit_multi_url.md): 草料开放平台 V2 接口 qrcodes/editMultiUrl:修改网址聚合码的名称或链接清单; - [修改批量生成的单个子码](https://cli.im/open-api/openapi/v2/reference/qrcode_children_edit.md): 草料开放平台 V2 接口 qrcodeChildren/edit:修改批量生成的单个子码的名称或字段值,values 只传要改的字段。 - [修改表单之前读取字段、版本和是否可改](https://cli.im/open-api/openapi/v2/reference/forms_get_edit_state.md): 草料开放平台 V2 接口 forms/getEditState:修改表单之前先调用:返回字段(field_id 为持久 ID)、version、editable 和 reason。 - [修改表单的名称或字段](https://cli.im/open-api/openapi/v2/reference/forms_edit.md): 草料开放平台 V2 接口 forms/edit:修改表单的名称或字段。 - [预览要删除的码并取得确认令牌,不删除](https://cli.im/open-api/openapi/v2/reference/qrcodes_preview_delete.md): 草料开放平台 V2 接口 qrcodes/previewDelete:删除码之前必须先调用:复核权限和锁定状态,返回将被删除的 items 和 10 分钟内有效的 confirm_token,不做任何修改。 - [凭确认令牌删除码](https://cli.im/open-api/openapi/v2/reference/qrcodes_delete.md): 草料开放平台 V2 接口 qrcodes/delete:删除普通码、跳转码、聚合码或子码,不支持母模板和静态码。 - [预览要删除的表单并取得确认令牌,不删除](https://cli.im/open-api/openapi/v2/reference/forms_preview_delete.md): 草料开放平台 V2 接口 forms/previewDelete:删除表单之前必须先调用:复核权限并确认表单未关联任何码、不是系统表单,返回 items 和 10 分钟内有效的 confirm_token,不做任何修改。 - [凭确认令牌删除表单](https://cli.im/open-api/openapi/v2/reference/forms_delete.md): 草料开放平台 V2 接口 forms/delete:删除未关联任何码的表单。 - [查找可用于建码的模板](https://cli.im/open-api/openapi/v2/reference/templates_list_editable.md): 草料开放平台 V2 接口 templates/listEditable:分页返回可用于建码的模板摘要(名称、template_id、project_id、category_id 等),只读,不修改模板。 - [读取模板字段结构和版本](https://cli.im/open-api/openapi/v2/reference/templates_get_schema.md): 草料开放平台 V2 接口 templates/getSchema:读取模板的字段、类型、写入限制、正文图文组件和版本。 - [创建基础信息模板](https://cli.im/open-api/openapi/v2/reference/templates_create.md): 草料开放平台 V2 接口 templates/create:创建基础信息模板,字段支持 text/textarea/number/date/image/file,可带正文图文组件并绑定已有表单。 - [预览模板修改及影响范围](https://cli.im/open-api/openapi/v2/reference/templates_preview_edit.md): 草料开放平台 V2 接口 templates/previewEdit:预览模板修改及受影响的子码数量,返回有时效的 preview_token,不保存。 - [保存基础信息模板修改](https://cli.im/open-api/openapi/v2/reference/templates_edit.md): 草料开放平台 V2 接口 templates/edit:保存模板修改,需要当前 template_version 和幂等键 idempotency_key。 - [创建填写表单及可选周期](https://cli.im/open-api/openapi/v2/reference/forms_create.md): 草料开放平台 V2 接口 forms/create:创建填写表单,支持基础字段、单选计分和可选的日/周/月/年周期。 - [申请临时文件上传](https://cli.im/open-api/openapi/v2/reference/assets_request_upload.md): 草料开放平台 V2 接口 assets/requestUpload:为本地图片或文件申请临时上传,每个文件需要固定的幂等键 idempotency_key。 - [查询临时文件上传状态](https://cli.im/open-api/openapi/v2/reference/assets_get_upload.md): 草料开放平台 V2 接口 assets/getUpload:用 file_key 查询上传状态。 - [读取当前标签样式与支持的导出格式](https://cli.im/open-api/openapi/v2/reference/labels_get_config.md): 草料开放平台 V2 接口 labels/getConfig:读取普通码、子码或母模板当前关联标签的样式、尺寸、展示字段和 supported_formats。 - [按当前样式预览指定码的标签](https://cli.im/open-api/openapi/v2/reference/labels_preview.md): 草料开放平台 V2 接口 labels/preview:按当前标签样式为指定的码生成预览:普通码每次 1 个,同一母模板的子码最多 3 个,两者不能混用。 - [为明确指定的码创建标签导出任务](https://cli.im/open-api/openapi/v2/reference/label_exports_create.md): 草料开放平台 V2 接口 labelExports/create:沿用当前标签样式为明确指定的码创建导出任务:普通码每次 1 个,同一母模板的子码最多 100 个,格式须是 labels/getConfig 返回的 supported_formats 之一。 - [查询标签导出任务及下载文件](https://cli.im/open-api/openapi/v2/reference/label_exports_get.md): 草料开放平台 V2 接口 labelExports/get:查询标签导出任务的状态(pending/running/succeeded/failed/expired/unknown)和下载文件,按 poll_after_seconds 轮询原任务。 - [分页查询周期计划](https://cli.im/open-api/openapi/v2/reference/cycle_plans_list.md): 草料开放平台 V2 接口 cyclePlans/list:分页查找周期计划。 - [读取周期计划详情](https://cli.im/open-api/openapi/v2/reference/cycle_plans_get.md): 草料开放平台 V2 接口 cyclePlans/get:读取指定周期计划的表单、执行状态、周期配置及本期、上期概况。 - [分页查询某个周期内各码的执行情况](https://cli.im/open-api/openapi/v2/reference/cycle_tasks_list_qrcodes.md): 草料开放平台 V2 接口 cycleTasks/listQrcodes:按码分页返回某个周期内各码的执行情况。 - [查询各周期的完成情况](https://cli.im/open-api/openapi/v2/reference/cycle_tasks_get_completion.md): 草料开放平台 V2 接口 cycleTasks/getCompletion:按计划 ID 和时间范围查询各周期的完成、未完成数量,周期状态和跳过原因。 ## 二维码图片与标签 - [二维码图片工具:免鉴权的二维码生成与解码 API](https://cli.im/open-api/qrcode-api/quick-start.md): 草料二维码免鉴权的二维码生成与解码 API:一个 GET 请求生成二维码图片(PNG、SVG),或读取图片里的二维码内容,附 Python、PHP、JavaScript 示例。 - [生成二维码 API(免鉴权)](https://cli.im/open-api/qrcode-api/create-qr-code.md): 草料二维码生成 API,不需要鉴权:GET 请求 api.2dcode.biz/v1/create-qr-code 生成二维码图片,支持尺寸、格式(PNG、SVG)、纠错级别和边框参数。 - [二维码解码 API(免鉴权)](https://cli.im/open-api/qrcode-api/read-qr-code.md): 草料二维码解码 API,不需要鉴权:传图片地址或上传图片文件,返回图中所有二维码的内容。 - [二维码扫描:识别码的内容和来源(v1)](https://cli.im/open-api/openapi/api/qr-codes/scan-url.md): 草料二维码 API 的二维码扫描接口(v1):传图片地址,解析图中二维码的内容,并识别二维码的来源,如支付宝、微信支付、微信公众号文章。当前版本还没有替代接口,这个接口继续可用。 - [标签生成 API 概述](https://cli.im/open-api/label-api/intro.md): 草料二维码标签生成 API:在自己的系统或网页里调用草料二维码的标签样式,批量生成一物一码二维码标签,分公共样式和私有样式两种调用方式。 - [标签生成 API:公共样式](https://cli.im/open-api/label-api/public-style-label.md): 草料二维码标签生成 API 的公共样式接口:传公共样式编号和内容,批量生成二维码标签,含请求参数、返回参数、错误码和调用示例。 - [标签生成 API:私有样式](https://cli.im/open-api/label-api/private-style-label.md): 草料二维码标签生成 API 的私有样式接口:用 api_key 加签名调用账号下保存的标签样式,批量生成二维码标签,含加签方式、参数、错误码和调用示例。 ## 数据同步 - [数据同步:三种方式怎么选](https://cli.im/open-api/data-api/data-push.md): 把草料二维码的数据同步到你的系统有三种方式:Webhook 实时推送、数据库直连、用 API 主动拉取。按场景选择,并了解各版本的每月推送条数。 - [Webhook 推送](https://cli.im/open-api/data-api/webhook.md): 草料二维码 Webhook 推送:把动态数据以 JSON 格式实时推送到你指定的接口地址,用于消息提醒和业务系统对接,含配置步骤、推送格式和常见问题。 - [数据库直连](https://cli.im/open-api/data-api/db.md): 草料二维码里的数据库直连:官方数据库和自有数据库的区别与开通方法,15 张数据表的字段说明、事件推送说明和常见问题。 - [用 BI 做看板](https://cli.im/open-api/data-api/BI/api-with-sugar.md): 把草料二维码里的数据同步到官方数据库或自有数据库,再用百度 SugarBI 等 BI 工具搭建可视化看板:案例效果、使用前须知和搭建教程。 ## 应用集成(无需写代码) - [腾讯轻联:打通草料与其他应用](https://cli.im/open-api/integration/hiflow/with-third-app.md): 通过腾讯轻联把草料二维码和企业微信、钉钉、飞书、腾讯文档等应用连起来:不用写代码,表单有新数据时同步到在线表格、推送到工作群或传给内部业务系统。 - [腾讯轻联:同步表格与群消息推送](https://cli.im/open-api/integration/hiflow/to-ol-sheets.md): 通过腾讯轻联,把草料二维码表单数据同步到腾讯文档、维格表等在线表格,或即时推送到企业微信、飞书、钉钉工作群。 - [企业微信版功能介绍](https://cli.im/open-api/integration/wework/intro.md): 草料二维码企业微信版功能介绍:在企业微信里使用草料二维码,包含权限控制、即时转发、管理员操作和常见问题。 - [企业微信版安装与集成](https://cli.im/open-api/integration/wework/setup/with-wework.md): 把草料二维码集成到企业微信:已有草料二维码账号集成企业微信,或企业微信已安装应用后导入已有账号数据。 - [企业微信版通讯录与成员姓名](https://cli.im/open-api/integration/wework/edit-book.md): 草料二维码企业微信版通讯录管理:调整应用可见范围同步成员,完善成员的补充姓名,以及企微接口许可费用相关问题。 - [飞书×草料二维码插件](https://cli.im/open-api/integration/feishu/intro.md): 飞书多维表格里的草料二维码插件:在多维表格中选中记录,批量生成二维码标签,含功能说明和使用教程。 - [腾讯文档×草料二维码插件](https://cli.im/open-api/integration/qqdocs/intro.md): 腾讯文档里的草料二维码插件:分享文档时生成二维码、在文档中插入二维码、美化文档中已有的二维码,提供 150+ 样式模板,可调整 Logo、颜色和文字。 ## 相关产品 - [草料扫码器技能包](https://cli.im/open-api/deepscan/skills.md): 草料扫码器技能包:在 AI 客户端里管理扫码本、添加和查看扫码记录、导出数据,支持扫码登录或 API Key。 ## 更新与历史版本 - [更新日志](https://cli.im/open-api/changelog.md): 草料开放平台文档与接口说明的更新记录。 - [从 v1 迁移到当前版本](https://cli.im/open-api/openapi/migrate-from-v1.md): 草料二维码活码 API v1 到当前版本的接口对照表,以及暂时没有替代的接口。 - [读取活码内容(Markdown,v1 旧版)](https://cli.im/open-api/openapi/api/activate-qr-codes/read-markdown.md): 草料二维码活码 API v1(不再更新)的读取活码内容接口,返回 Markdown 格式。新项目请用活码内容接口。 - [读取活码内容(JSON,v1 旧版)](https://cli.im/open-api/openapi/api/activate-qr-codes/read-json.md): 草料二维码活码 API v1(不再更新)的读取活码内容接口,返回 JSON 格式。新项目请用活码内容接口。 - [二维码富文本模块 ContentModule(v1 旧版)](https://cli.im/open-api/openapi/api/activate-qr-codes/qrcode-content-schema.md): 草料二维码活码 API v1(不再更新)返回的富文本模块 ContentModule 定义:文本、图片、音频、视频、联系方式和文件模块的结构与示例。新项目请看活码内容接口。 - [获取表单数据(v1 旧版)](https://cli.im/open-api/openapi/api/forms/get-data.md): 草料二维码活码 API v1(不再更新)的获取表单数据接口:按二维码 URL、表单 ID 和时间范围获取表单数据列表。新项目请用记录列表接口。 - [表单字段 FormField(v1 旧版)](https://cli.im/open-api/openapi/api/forms/form-field-schema.md): 草料二维码活码 API v1(不再更新)的表单字段 FormField 定义:各类型字段的属性对照表和示例数据。新项目请看表单结构和表单组件类型。 - [获取模板组件(v1 旧版)](https://cli.im/open-api/openapi/api/template-qrcodes/get-template.md): 草料二维码活码 API v1 的获取模板组件接口(不再更新):读取批量模板的可变内容组件。新项目请用模板结构接口。 - [获取子码内容(v1 旧版)](https://cli.im/open-api/openapi/api/template-qrcodes/get-qrcode-msg.md): 草料二维码活码 API v1 的获取子码内容接口(不再更新)。新项目请用子码内容接口。 - [模板组件字段说明(v1 旧版)](https://cli.im/open-api/openapi/api/template-qrcodes/template-form.md): 草料二维码活码 API v1(不再更新)获取模板组件接口返回的模板组件定义和示例数据。新项目请用批量模板结构接口。 - [子码组件字段说明(v1 旧版)](https://cli.im/open-api/openapi/api/template-qrcodes/template-qrcode-form.md): 草料二维码活码 API v1(不再更新)获取子码内容接口返回的子码组件定义和示例数据。新项目请用子码内容接口。 - [记录凭证核销(v1 旧版)](https://cli.im/open-api/openapi/api/record/certificate-verification.md): 草料二维码活码 API v1 的记录凭证核销接口(不再更新):推进到下一状态或切换到指定状态。新项目请用核销记录凭证接口。 - [旧版二维码美化API](https://cli.im/open-api/label-api/old-style-label-api.md): 草料二维码旧版二维码美化 API,已停止维护:通过 HTTP 请求生成自定义颜色、形状、背景和 Logo 的二维码。新项目请用标签生成 API。