接口简介
「编号校验」(checkcode)是数据鱼API平台提供的编号校验位计算与格式校验接口,对统一社会信用代码、组织机构代码、ISBN、ISSN、IMEI 五类编号做校验位计算与格式校验,并支持 ISBN-10 与 ISBN-13 的双向转换,Base 路径 /api/checkcode,共 4 个端点,是数据鱼API 开发工具类的组成之一。它解决的问题是:录入与对账环节需要快速判断一串编号「格式是否合法、校验位是否正确」,而这类国标与国际标准算法在各业务系统里反复重复实现。
全部计算为纯本地算法执行,依据公开国标与国际标准:统一社会信用代码依据 GB 32100-2015(18 位,字符集不含 I/O/S/V/Z 等易混字母),组织机构代码依据 GB 11714-1997(9 位,可含连字符),ISBN-13 采用 EAN-13 加权 1/3 校验,ISBN-10 与 ISSN 采用加权和取模 11(校验位可为 X),IMEI 为 15 位数字加 Luhn 校验。
服务无状态、不落库、不写文件,只做校验位与格式判定,不查询号码是否真实注册或归属,因此返回结果即最终判定,无外部依赖超时风险。
端点总览
方法 路径 说明 鉴权
GET /api/checkcode/ping 健康检查,返回版本、支持类型与端点清单 是
GET /api/checkcode/types 类型规则说明(国标依据、长度、字符集、校验算法) 是
GET /api/checkcode/validate 校验位验证,支持指定类型校验 是
GET /api/checkcode/convert ISBN-10 与 ISBN-13 双向转换并重算校验位 是
通用约定
鉴权:全站统一 Key,经 X-API-Key 请求头或 ?api_key= 查询参数传递;缺失返回 4011,无效返回 4013。实测包括 ping 在内的全部端点都需要鉴权。
响应结构:统一 {"code": 0, "msg": "...", "data": {...}};参数错误 4001(缺参)、4002(参数非法),路由错误 4040,服务端错误 5000。
特别口径:校验位不匹配时 HTTP 仍为 200、业务码为 0,msg 为「校验失败」,判定结果在 data.valid 字段(false),调用方应以 valid 而非业务码判断编号合法性。
参数传递:GET 与 POST 等价,POST 支持 JSON body 或表单,参数名与 query 一致。
以上为数据鱼API平台全站通用约定,其中「校验失败仍返回业务码 0」为本接口特有口径,接入时需特别注意。
核心端点详解
校验位验证 validate
对单个编号执行校验位验证。返回标准化结果(去连字符、转大写)、分解字段与判定结论。
参数 类型 必填 默认 说明
type string 是 — 类型标识:uscc/orgcode/isbn13/isbn10/issn/imei
code string 是 — 待校验编号,可含连字符,大小写不敏感
返回字段要点:type、input/normalized、payload 与 check_char(本体与校验位)、input_check_char 与 input_has_check(用户是否自带校验位)、valid(判定结论)、expected_code(正确校验位的编号)。统一社会信用代码额外返回 department(登记管理部门)、category(机构类别)、region(登记机关行政区划码)与 body(主体标识码)等分解字段。
GET /api/checkcode/validate?type=uscc&code=91110000100000007G&api_key=YOUR_KEY
实测该示例返回 valid=false,并给出 expected_code(校验位应为 F),可直接用于提示用户录入错误。
ISBN 互转 convert
在 ISBN-10 与 ISBN-13 之间双向转换并重算校验位,输入任一形态自动识别方向。
参数 类型 必填 默认 说明
code string 是 — ISBN-10(10 位)或 ISBN-13(13 位,前缀 978/979)
返回 direction(isbn10_to_isbn13 或 isbn13_to_isbn10)、prefix 与 prefix_valid(前缀校验)、valid、isbn13 或 isbn10 字段(转换结果)。转换前会先校验输入合法性,校验失败的输入会得到 valid=false 与重算后的期望编号。
GET /api/checkcode/convert?code=0306406152&api_key=YOUR_KEY
辅助端点
ping:返回版本、时间、支持类型列表、端点清单与「仅校验位格式、不查注册」的口径声明。
types:返回各类型的规则说明,含国标依据(GB 32100-2015、GB 11714-1997)、长度构成、字符集与校验算法名,可作为前端校验提示与文档展示的数据源。
数据与限制
支持类型:uscc、orgcode、isbn13、isbn10、issn、imei 共六类 slug;类型与规则由 types 端点输出,新增类型以该端点为准。
判定边界:只验证校验位与格式(长度、字符集、前缀),不查询号码是否真实注册、是否有效存续或归属信息。
输入宽容度:连字符与大小写不敏感,服务端先归一化再计算;空格等非法字符按 4002 处理。
无状态:不落库、不写文件、不依赖外部服务,适合高频调用与批处理前置过滤。
典型使用场景
表单实时校验:注册、备案、结算页面在提交前调用 validate,用 valid 与 expected_code 给出「校验位应为 X」的具体提示。
数据清洗:对历史数据库中的信用代码、ISBN 批量跑校验位,筛出录入错误记录。
图书与出版系统:convert 在新旧编号体系间迁移数据,ISBN-10 老书目自动补算 ISBN-13。
注意事项
文档标注 type 可缺省自动识别,实测实现要求必须传 type(缺省返回 4001 缺少参数),调用方应显式传类型;无法确定类型时可先按长度与字符集在调用侧预判。
valid=false 时业务码仍为 0、HTTP 仍为 200,勿以业务码判断校验结果;「校验通过」仅代表校验位正确,不代表编号已实际注册。
类型与算法依据为公开标准文本,若标准修订(如新增前缀段),以 types 端点实时返回为准。
本接口输出仅为格式与校验位判定结论,不构成对主体资质、出版物真伪或设备来源的任何核验结论。
本接口属于数据鱼API平台开发工具类接口,鉴权与错误码处理方式与其他接口一致。