Integrating the ORedact API: from sample validation to production
The full path to integrating the image and video redaction API: the 14-day trial allowance, sample validation and acceptance criteria, the three-step asynchronous task flow, callbacks and billing rules, retention and concurrency agreements, and a go-live checklist to prepare before integration starts.
Articles in this section are written in Chinese; the title and abstract are in English.
这篇文章按时间顺序说明企业接入图片、视频打码 API 会经过的每一步,以及每一步你需要准备什么。接口路径和字段见资料栏的《ORedact API 文档》,这里只讲流程。
第 0 步:先确定是不是 API
两条路径:个人和小团队直接在打码鸭网页上传处理,不需要接入;要把打码接进自己系统、批量跑、按结果做后续流程的团队,走 API。判断标准不是量大小,而是"结果要不要回到你的系统里"。
第 1 步:注册控制台(第 1 天)
在控制台(console.oredact.com)用邮箱注册,注册即开通工作空间,预置图片、视频两个模板,自己创建 API Key,不用等审核。试用额度随注册发放:14 天,100 张图片 + 30 分钟视频(不区分分辨率),每个账号一次。试用期的目的只有一个:用你的真实素材走通从提交到拿到结果的全流程,并确认效果。
第 2 步:样本验证(第 1–5 天)
准备 10–30 个真实样本,覆盖你实际会遇到的情况,而不是挑最容易的:
- 图片:不同分辨率、人多人少、夜间、有无文字。
- 视频:室内 / 街景 / 车载各一条,有人物进出画面的、有车牌倾斜的。
验证时看三件事:
- 效果:按口径数漏检和误遮(可参考《视频打码怎么验收》一文的分级方法)。
- 规格:标准范围是图片 JPEG / PNG / WebP 最高 12MP,视频 MP4 / MOV、H.264 / HEVC、最高 1080p、30 FPS、单条 5 分钟。2K、4K 与 HEVC 源片同样支持(2K、4K 按各自档位计费,试用额度不区分分辨率),有这类素材就在这一步一起验证。
- 耗时:异步任务的实际排队和处理时间,用来设计你那边的轮询或回调。
第 3 步:接口联调(第 3–10 天)
标准流程是三步异步调用:
- 提交任务:给出文件地址和处理对象(人脸、车牌、敏感文字),可选打码样式和强度。
- 查询状态:轮询进度,或等回调。排队和查询不计费。
- 获取结果:下载成片和对象清单(类别、位置),在约定保留期内自行保存。
联调时要确认的细节:
- 回调地址的鉴权方式和重试策略。
- 失败的分类:校验不通过(格式、尺寸)和系统处理失败都不扣费,但你的系统要能区分并处理。
- 对象清单的用途:用它做抽检、做"保留某人后重新生成",还是只存档。
第 4 步:商务确认(第 7–14 天)
试用通过后确认这几项,再开通生产调用:
- 价格:图片 0.08 元 / 张;视频按短边分档,标准档(不超过 1080 像素)0.90 元 / 分钟、2K 1.20 元 / 分钟、4K 1.80 元 / 分钟,都按秒计费,无月平台费。视频按每条输入的真实时长向上取整到秒计费,不按整分钟起算。
- 充值方式、余额有效期和对账方式。
- 数据保留期:源文件、缓存、结果各保留多久、怎么删除。
- 并发限额:同时处理的任务数;高峰期的处理方式。
- 支持范围:接口变更通知、故障响应。
私有化部署、专属算力和定制开发按项目约定交付范围与费用。
第 5 步:上线前检查清单
- 样本验证的漏检和误遮数据已记录,口径双方认可
- 超出标准范围的素材已单独确认(或在你的系统里拦截)
- 回调或轮询已在测试环境跑通,失败分支有处理
- 结果文件的保存位置和保留策略已定,不依赖我们长期托管
- 抽检比例和验收单已定(上线初期建议 20%)
- 合同或接入协议写明保留期、删除方式、不用于训练
- 内部的个人信息保护影响评估已记录
常见的时间线
走得快的团队两周内完成:第 1 周样本验证加联调,第 2 周商务确认和小批量上线。慢的通常卡在样本准备和口径讨论,而不是技术对接。所以建议在注册之前就把样本攒好。