接口简介
「URL 安全 Base64 编解码」是数据鱼API平台提供的 URL 安全 Base64 编码与解码接口,Base 路径 /api/base64-url,共 3 个端点。标准 Base64 输出中的加号与斜杠在 URL、路径与文件名等场景会产生歧义,需要替换为连字符与下划线并去掉填充等号;这一变换各地实现不一,跨语言对接时容易出现填充与字符集不匹配的问题。该接口把 URL 安全 Base64 的编码与解码做成两个端点,为调用方提供一致的口径。
编码端点按标准 Base64 处理输入文本,随后将字符表中的加号与斜杠替换为连字符与下划线,并去除末尾的填充等号,输出不带填充的 URL 安全串,可直接放入查询参数或路径段。解码端点执行逆变换:先把连字符与下划线还原为标准字符表,再按宽松模式解码——即输入是否带填充、填充是否完整都能被接受,兼容各类语言运行时产出的历史数据。
接口为无状态纯计算实现,不做字符集转码假设:输入按字节处理,UTF-8 文本编解码后保持原样。数据鱼API 的该接口只有三个端点,行为可预期,适合作为多语言环境下的统一编解码入口。
端点总览
方法 路径 说明 鉴权
GET /api/base64-url/ping 健康检查,返回版本号 免鉴权
POST /api/base64-url/encode 编码为 URL 安全 Base64(无填充) 需要
POST /api/base64-url/decode 解码 URL 安全 Base64 需要
通用约定
鉴权使用数据鱼API 全站统一 Key(X-API-Key 头或 ?api_key= 参数);4011/4013 含义与全站一致。响应为 {code, msg, data}。本接口特有约定:两个功能端点只接受 POST 请求,text 参数通过 JSON 请求体传递,缺失或为空返回 4001 Missing text(HTTP 400)。
核心端点详解
编码 encode
参数 类型 必填 默认 说明
text string 是 - 待编码的原文文本
处理流程:按字节做标准 Base64 编码 → 加号与斜杠替换为连字符与下划线 → 去除末尾填充等号。返回 result 字段。以 hello world 为例,标准 Base64 输出以加号结尾并带一个填充等号,本接口输出为不带填充的 aGVsbG8gd29ybGQ。
POST /api/base64-url/encode
Content-Type: application/json
X-API-Key: YOUR_API_KEY
{"text": "hello world"}
解码 decode
参数 类型 必填 默认 说明
text string 是 - URL 安全 Base64 串,带或不带填充均可
处理流程:连字符与下划线还原为加号与斜杠 → 宽松模式 Base64 解码。返回 result 字段。宽松模式会忽略不合法字符,因此对带填充的标准 Base64、不带填充的 URL 安全串、甚至混有换行符的输入都能解出结果。
POST /api/base64-url/decode
Content-Type: application/json
X-API-Key: YOUR_API_KEY
{"text": "aGVsbG8gd29ybGQ"}
数据与限制
编码输出恒为无填充的 URL 安全字符表(字母、数字、连字符、下划线),可直接用于路径段与查询参数,无需再转义。
解码为宽松模式:非法字符被跳过而非报错,输入被截断到可解的最长前缀时也不返回错误。
解码对象不限于文本:编码二进制数据后解码会得到原始字节,响应中的 result 以转义形式呈现,可能不可直接阅读。
接口不做字符集转换:多字节文本按 UTF-8 字节处理,编码与解码需两端字符集一致。
无状态、无缓存、无外部依赖;输入大小受服务端请求体限制约束。
典型使用场景
签名与令牌传递:把 JWT 风格的段或二进制令牌转成可安全放入 URL 的形态。
跨语言对接统一口径:各端不再各自实现填充处理,统一走服务端口径。
短标识生成:对自增 ID 或结构化串做轻量编码后用于分享链接与路径。
注意事项
text 参数只从 JSON 请求体读取,放在查询参数里即使带上了 api_key 也会返回 4001 Missing text;文档参数表中「类型:数组或对象、非必填」的描述与实现不符,应按必填字符串处理。
文档示例以空请求体演示并返回了编码结果,实测空请求体返回 4001;示例响应中的编码串对应 hello world,仅在传同样内容时才会出现。
解码端点不校验输入合法性,传错字符可能解出乱码或二进制噪声;对安全敏感的输入建议编码前约定固定格式、解码后做业务校验。
宽松解码意味着「解得出来」不等于「原文正确」,校验失败场景应自行在业务层兜底。
本接口随数据鱼API 平台统一升级,行为口径如有调整,以最新文档与实测为准。