首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >账号名占用检测 API 接口文档(数据鱼API)

账号名占用检测 API 接口文档(数据鱼API)

原创
作者头像
用户12862874
发布于 2026-11-21 21:31:08
发布于 2026-11-21 21:31:08
40
举报

接口简介

「账号名占用检测」是数据鱼API平台提供的用户名批量占位查询接口,Base 路径 /api/handle-check,共 2 个端点。它面向注册流程与品牌命名环节:输入一个候选用户名,一次返回该名字在数十个社交、开发与电商平台上的可用状态,省去逐站手工试注册。

需要先说明能力边界:当前版本的检测结果为本地确定性模拟,并未实时访问各平台。实现方式是把用户名与平台名拼接后取 CRC32 校验值,按奇偶判定占用或可用,因此同一用户名每次得到完全相同的分布,大约一半平台显示占用。响应的 url 字段在占用时按固定模板拼接,空闲时为 null,这些地址仅用于占位展示,不保证指向真实账号。

接口共覆盖 60 个平台,涵盖 GitHub、Twitter、Instagram 一类社交平台,npm、PyPI、RubyGems 一类包仓库,以及 Etsy、eBay、Shopify 一类电商与建站平台。平台清单硬编码在服务内,不提供增删或自定义。

因此该接口适合做原型演示、前端联调与命名初筛的交互占位;需要真实占用结论时,应回到目标平台的官方查询入口。数据鱼API在文档中按端点列出能力,本文同时标注文档与实现之间的差异,避免集成方误判数据性质。

端点总览

方法

路径

说明

鉴权

GET

/api/handle-check/ping

健康检查,返回服务版本与服务器时间

免鉴权

GET

/api/handle-check/audit

用户名占用检测,返回各平台状态与汇总计数

需要

通用约定

鉴权使用全站统一 Key,通过 X-API-Key 请求头或 ?api_key= 查询参数传递;/ping 免鉴权,适合做探活与版本核对。响应统一为 {"code":0,"msg":"success","data":{...}},/ping 的 msg 为 pong,版本号为 1.0.0。

错误码沿用全站定义:4011 为 Key 缺失,4013 为 Key 无效,4001 为缺少必填参数,4002 为参数格式非法。本接口的参数极少,实际会触发的多为鉴权类错误;audit 在未传用户名时不会报错,而是返回空的 available 与 taken 数组,这一点容易被误认为请求失败。

核心端点详解

占用检测 audit

输入候选用户名,返回逐平台状态与三类汇总计数。API.md 将本端点的请求参数标为「无」,但实现中读取 handle 参数;不传时返回空结果,传了才进入检测分支。

参数

类型

必填

默认值

说明

handle

string

否

空字符串

待检测的用户名;文档未列出,实现中读取

返回 handle(回显输入)、results(以平台键为属性的对象,每项含 status 与 url)、summary(含 total_platforms、available_count、taken_count)。status 只有 taken 与 available 两种取值;total_platforms 为平台总数 60,两个计数之和等于该值。

代码语言:javascript
复制
GET /api/handle-check/audit?handle=mybrand

健康检查 ping

无参数,返回 version 与服务器当前时间,用于确认服务存活及版本。该端点不校验 Key,即使携带无效 Key 也返回成功,因此不能用作鉴权自检。

代码语言:javascript
复制
GET /api/handle-check/ping

数据与限制

  • 平台清单固定 60 个,含社交、开发者社区、包管理器、电商与建站平台,不可配置。
  • 每个用户名对应 60 条状态,占用与可用由 CRC32 奇偶决定,分布接近各半但不保证精确均分。
  • 判定是确定性的:同一用户名重复请求结果完全一致;这与真实平台的动态占用不同。
  • 无批量入口,一次请求只处理一个用户名;如需多个候选名对比,需循环调用。
  • 无缓存层、无外部请求、无速率限制说明,响应时延取决于服务本身。
  • url 字段为模板拼接,占用时非空、可用时为空,不保证可访问。

典型使用场景

产品原型阶段,注册页需要展示「该用户名在多个平台是否可用」的交互效果,用本接口填充占位数据。

前端联调,验证多平台状态列表的渲染、排序与计数展示逻辑,不依赖真实网络请求。

命名工作流中的初筛演示,向团队说明跨平台用户名一致性的概念与展示形式。

注意事项

最重要的一条:audit 返回的是硬编码平台清单加哈希模拟的结果,不是真实占用查询。任何「可用」或「占用」结论都不能作为注册决策依据,尤其不能据此判断商标、域名或账号的实际归属。集成方应在界面上明确标注「模拟数据」,或仅在演示环境启用。

API.md 与本实现在参数上存在不一致:文档写「请求参数:无」,实现读取 handle;文档示例返回空的 available/taken 两个数组,而实现传入用户名后返回的是 results 对象与 summary,字段结构完全不同。以实际调用为准时,请按 results 结构解析,并对空结果做兼容。

handle 为空字符串时接口返回 200 与空数组,不返回 4001;集成方应自行做非空校验。用户名中的空格、特殊字符不会被清洗,直接参与哈希计算,建议提交前统一小写并去除空白。

本接口不涉及账号登录、不抓取平台页面、不存储查询记录,数据鱼API也不对其准确性作出承诺。真实占用情况请以各平台官方注册页的实时校验为准。

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

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

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