首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >接口简介 「WIPO 标准 ST」是数据鱼API平台提供的工业产权信息标准目录接口,Base 路径 /api/legal-wipo-standards-st,共

接口简介 「WIPO 标准 ST」是数据鱼API平台提供的工业产权信息标准目录接口,Base 路径 /api/legal-wipo-standards-st,共

原创
作者头像
用户12862874
发布于 2026-11-20 21:56:13
发布于 2026-11-20 21:56:13
160
举报

接口简介

「开源许可证查询」是数据鱼API平台提供的许可证要点速查接口,Base 路径 /api/license-lookup,共 2 个端点。调用方传入许可证标识,接口返回名称、允许的行为、需要满足的条件与责任限制三组要点,用于在依赖引入、代码分发或内部审查时快速核对条款轮廓。

当前支持的标识为 MIT、Apache-2.0 与 GPL-3.0,比较时不区分大小写。返回的 permissions、conditions、limitations 是英文短语数组,例如商业使用、修改、分发、专利授权、公开源码、保留版权声明等,属于条款摘要而非逐条译文。接口不返回许可证全文,也不判断多个许可证之间的兼容性。

数据鱼API把它设计成只读字典查询:没有状态、没有写入、没有调用记录。健康检查端点同时承担能力发现的作用,返回当前支持的标识列表,接入方可以在启动时缓存这份列表,避免把不受支持的标识发到业务请求里。

端点总览

方法

路径

说明

鉴权

GET

/api/license-lookup/ping

健康检查,返回支持的许可证标识列表

免鉴权

GET

/api/license-lookup/check

按标识查询许可证要点

需要 Key

通用约定

鉴权使用平台统一 Key,通过 X-API-Key 请求头或 ?api_key= 查询参数传递;未携带返回 4011,无效返回 4013。响应统一为 code、msg、data,成功时 code 为 0。接口接受 GET 与 POST,POST 可用 JSON body 或表单,参数名与查询串一致。

错误码中,4001 表示缺少必填参数,4002 表示参数格式或取值非法,4003 表示取值不在支持列表,4004 表示查询目标未收录;4040 为路由不存在,4050 为方法不允许,5000、5001 为服务内部错误。数据鱼API对参数类错误与服务故障分开统计,前者通常重试无意义,应直接修正请求。

核心端点详解

支持列表与健康检查

GET /api/license-lookup/ping 无参数、免鉴权,返回当前支持的许可证标识。它既可用于探活,也可用于能力发现。

参数

类型

必填

默认值

说明

无

—

—

—

该端点不接受业务参数

响应 data 只有 supported_licenses 一个字段,值为字符串数组。当前内容为 MIT、Apache-2.0、GPL-3.0。与部分接口不同,这里的 msg 是 success 而非 pong,判断健康状态应以 code 为 0 为准。

代码语言:javascript
复制
GET /api/license-lookup/ping

许可证要点查询

GET /api/license-lookup/check 按标识返回单个许可证的要点。

参数

类型

必填

默认值

说明

id

string

否

—

许可证标识,不区分大小写精确匹配

响应 data 含 name、permissions、conditions 与 limitations 四个字段,后三者为字符串数组。三个标识的要点对比如下:

标识

permissions

conditions

limitations

MIT

Commercial use、Modification、Distribution、Private use

License and copyright notice

Liability、Warranty

Apache-2.0

Commercial use、Modification、Distribution、Patent use、Private use

License and copyright notice、State changes

Liability、Trademark use、Warranty

GPL-3.0

Commercial use、Modification、Distribution、Patent use、Private use

Disclose source、License and copyright notice、Same license、State changes

Liability、Warranty

代码语言:javascript
复制
GET /api/license-lookup/check?id=MIT&api_key=YOUR_KEY

该例返回 MIT License,允许商业使用、修改、分发与私有使用,条件是保留许可证与版权声明,责任与担保被排除。

数据与限制

  • 仅支持 MIT、Apache-2.0、GPL-3.0 三个标识,大小写不敏感;建议调用前自行去除前后空格,再做比对。
  • 标识必须与列表完全一致,GPLv3、Apache 2.0、GPL-3.0-only 等常见写法都不会命中。
  • permissions、conditions、limitations 是固定英文短语,顺序固定,不随语言参数变化。
  • 没有全文、版本号、许可证兼容性矩阵、专利条款细节或商标条款原文。
  • 没有批量查询,一次只能查一个标识;也没有搜索或模糊匹配。
  • 结果不落库、不缓存,重复调用返回相同内容。
  • 列表端点免鉴权,业务端点需要 Key;两者都不依赖外部上游服务。

典型使用场景

  • 依赖扫描工具识别出许可证标识后,调用接口把标识展开成人类可读的要点,附在引入申请单里。
  • 开发者在选择项目许可证时,对比 MIT、Apache-2.0 与 GPL-3.0 在专利授权、源码公开与保留声明上的差异。
  • 内部培训或代码评审时,用固定标识查询结果制作对照表,统一团队对常见条款的理解。

注意事项

  • 文档把 id 标为可选,但实现中该参数为空会直接返回 4001,应视为必填。
  • 未收录的标识返回 4041 与 License not found,HTTP 状态为 404;该错误码不在通用错误表中,需要单独处理。
  • 名称字段是许可证通称,例如 GPL-3.0 返回 GNU GPLv3,不能据此判断是 only 还是 or later 版本。
  • 要点数组是摘要,省略了通知期限、专利终止、网络分发等细则,不能代替逐条阅读。
  • 标识比较是精确匹配,接入前应先规范化,例如统一转为小写并去除空格,再与支持列表比对。
  • 数据鱼API不提供兼容性判断,也不对具体项目的分发方式作结论。仅供参考,不构成法律意见;许可证条款以官方全文为准,不构成合规审查,正式使用前请咨询专业律师。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

目录
  • 接口简介
  • 端点总览
  • 通用约定
  • 核心端点详解
    • 支持列表与健康检查
    • 许可证要点查询
  • 数据与限制
  • 典型使用场景
  • 注意事项
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档