- 1注册与验证建立真实账号
- 2创建应用与密钥绑定应用身份
- 3下载与调用服务端执行查询
- 4核对返回与日志按requestId追踪
- 5授权与内容回传许可后再使用
1. 注册与验证
注册开发者账号并验证邮箱;已注册用户可登录。本地验证码是测试收件箱中的随机六位数,不存在通用默认码;真实短信/邮件未接入。密码8–128位。
2. 创建应用与密钥
进入应用与API Key管理创建Application及Key。完整密钥仅创建时显示一次,私下保存到调用进程环境变量FACEPIC_API_KEY,不放在浏览器、URL、聊天、Git或日志。密钥只能代表所属应用。
3. 下载与调用
Node.js 22及以上。下载两个文件放在同一目录,私下设置FACEPIC_API_KEY,运行node quickstart.mjs。无需安装未发布的FacePick包。FACEPIC_BASE_URL本地默认为http://127.0.0.1:3110;其它服务地址需单独授权。
先GET /api/developer/whoami核对应用,再GET /api/developer/faces查询公开资产;仅查询不会扣许可次数,也不生成图片。下方代码可保存为同目录中的.mjs文件执行。
请求示例
import {FacePickClient} from './facepick-client.mjs';
try {
const client = new FacePickClient({
baseUrl: process.env.FACEPIC_BASE_URL ?? 'http://127.0.0.1:3110',
apiKey: process.env.FACEPIC_API_KEY,
});
const identity = await client.identity();
const faces = await client.searchFaces(process.env.FACEPIC_QUERY ?? '');
console.log(JSON.stringify({
applicationId: identity.data.applicationId,
count: faces.data.length,
requestId: faces.requestId,
}));
} catch (error) {
console.error(JSON.stringify({
code: error.code ?? 'CLIENT_ERROR',
status: error.status ?? 0,
requestId: error.requestId ?? null,
}));
process.exitCode = 1;
}4. 核对返回与日志
脚本exit code为0且applicationId匹配您的应用后,用搜索返回的requestId在查看真实调用日志核对。401检查密钥是否正确或已撤销;404检查FaceID及发布状态;网络超时不代表服务端没有处理。不要打印凭据或完整敏感响应。
返回结构说明
以下是字段结构,不是假成功响应;本页不检查您的调用结果。
成功响应结构:{ data, requestId }
失败响应结构:{ code, message, requestId, details? }
脚本输出:{ applicationId, count, requestId }
count 为 0 是真实空结果,不是生成失败。
HTTP错误由客户端抛出,不用旧 code=0 判断成功。5. 授权与内容回传
查询FaceID并不授予使用权。可通过授权申请表达用途,申请批准也不等于License。实际许可包需权利人确认条款,参与竞拍并完成沙箱付款后取得许可。每场保证金独立,中标后一小时付款。
核对有效许可与额度后,用该应用Key调用许可使用接口;成功扣一次次数,训练权限独立。稳定幂等键用于同请求重试,Use不是生成任务。AI 生成能力即将上线。已有真实文件按内容回传与审核说明上传并追踪审核,不伪造生成结果。
后续收益结算、真实KYC/支付/生成/自动审核及生产部署尚未完成,不能从本指南推断已上线。