Skip to content

API 接口清单 ​

V2 的全部 63 个接口,按业务分组。每个接口都是 POST https://open.cli.im/api/v2/rpc/{路径},请求体为 JSON。本页由 openapi.json 生成,各接口的请求字段以它为准。

凭证与额度 ​

查询当前凭证所属组织、档位和可用能力,以及组织当日额度。

接口路径最低权限组织 Key
查询当前凭证的组织、权限和可用操作auth/getContext只读可以
查询当前组织的当日额度usage/get只读可以

活码 ​

查询活码列表、内容和操作面板。

接口路径最低权限组织 Key
活码内容qrcodes/getContent只读可以
活码关联的操作项qrcodes/getOperation只读可以
活码列表qrcodes/list只读可以

模板与子码 ​

查询批量模板及其子码。

接口路径最低权限组织 Key
批量模板列表templates/list只读可以
批量模板结构templates/get只读可以
模板下子码列表templates/listQrcodes只读可以
子码内容templates/getSubcode只读可以

表单与记录 ​

查询表单结构和填写记录,新增填写记录,核销凭证。

调用流程见:查询二维码关联表单和记录、向指定二维码下的表单提交记录。

接口路径最低权限组织 Key
表单结构/内容forms/getTemplate只读可以
获取单条记录详情record/getRecord只读可以
获取记录列表record/getRecords只读可以
获取表单列表record/getFormList只读可以
添加记录record/addRecord读写可以
凭证核销certificates/verify读写可以
分页读取填写记录的后续动态record/getActivities只读—
按条件检索记录摘要record/searchRecords只读可以

分区 ​

查询组织内的分区。

接口路径最低权限组织 Key
分区列表projects/list只读可以

指标 ​

查询指标定义并按维度取数。

接口路径最低权限组织 Key
列出业务对象和可用指标metrics/list只读可以
读取指标定义metrics/get只读可以
查询指标数据metrics/query只读可以

官方模板 ​

浏览官方模板库,并用官方模板生成单个码或批量生成二维码。

接口路径最低权限组织 Key
浏览官方模板库的场景和行业分类gallery/categories只读—
搜索官方模板库gallery/list只读—
读取官方模板详情gallery/get只读—
准备官方模板生成二维码方案gallery/prepare-creation读写—
用官方模板生成单个码gallery/create-qrcode读写—
执行官方模板生成二维码方案gallery/create-from-plan读写—

生成二维码与批量任务 ​

创建普通码、网址跳转码、网址聚合码和静态码;按已有模板预校验并提交批量生成二维码,查询任务进度和逐项结果。

调用流程见:按模板批量生成二维码。

接口路径最低权限组织 Key
批量生成二维码预校验,不创建二维码qrcodes/prevalidate读写—
提交批量生成二维码任务qrcodes/createBatch读写—
查询生成二维码任务进度qrcodeTasks/get读写—
查询当前可用于新建的分区或目录qrcodes/listCreateTargets只读—
分页读取批量生成二维码逐项结果qrcodeTasks/getResults读写—
创建普通图文码并绑定表单qrcodes/create读写—
创建网址跳转码qrcodes/createUrlJump读写—
创建网址聚合码qrcodes/createMultiUrl读写—
创建文本或网址静态码staticQrcodes/create读写—

编辑与删除 ​

修改和删除码、表单。修改前先读取编辑状态取得 version;删除分两步,先预览取得确认令牌,再凭令牌删除。

调用流程见:修改和删除码、表单。

接口路径最低权限组织 Key
修改码之前读取当前内容、版本和是否可改qrcodes/getEditState读写—
修改普通码或图文展示码qrcodes/edit读写—
修改网址跳转码的名称或跳转地址qrcodes/editUrlJump读写—
修改网址聚合码的名称或链接清单qrcodes/editMultiUrl读写—
修改批量生成的单个子码qrcodeChildren/edit读写—
修改表单之前读取字段、版本和是否可改forms/getEditState读写—
修改表单的名称或字段forms/edit读写—
预览要删除的码并取得确认令牌,不删除qrcodes/previewDelete完全—
凭确认令牌删除码qrcodes/delete完全—
预览要删除的表单并取得确认令牌,不删除forms/previewDelete完全—
凭确认令牌删除表单forms/delete完全—

模板与表单管理 ​

查找、创建和修改基础信息模板,创建填写表单。

接口路径最低权限组织 Key
查找可用于生成二维码的模板templates/listEditable只读—
读取模板字段结构和版本templates/getSchema只读—
创建基础信息模板templates/create读写—
预览模板修改及影响范围templates/previewEdit读写—
保存基础信息模板修改templates/edit读写—
创建填写表单及可选周期forms/create读写—

素材上传 ​

为本地图片和文件申请临时上传,取得生成二维码时引用的 file_key。

调用流程见:按模板批量生成二维码。

接口路径最低权限组织 Key
申请临时文件上传assets/requestUpload读写—
查询临时文件上传状态assets/getUpload读写—

标签 ​

读取标签样式,预览并导出指定码的标签。

调用流程见:导出可打印的标签。

接口路径最低权限组织 Key
读取当前标签样式与支持的导出格式labels/getConfig只读—
按当前样式预览指定码的标签labels/preview只读—
为明确指定的码创建标签导出任务labelExports/create读写—
查询标签导出任务及下载文件labelExports/get读写—

周期计划 ​

查询周期计划及各周期的完成情况。

接口路径最低权限组织 Key
分页查询周期计划cyclePlans/list只读—
读取周期计划详情cyclePlans/get只读—
分页查询某个周期内各码的执行情况cycleTasks/listQrcodes只读—
查询各周期的完成情况cycleTasks/getCompletion只读—