外部渠道发布接口怎样验收
建站项目里对接外部渠道发布接口时,最容易出现的误判是把接口返回成功当成内容已经公开可见。实际上接收只是第一步,字段是否被正确解析、图片是否可用、重复提交会不会生成多条、平台审核处于什么状态、撤销后是否真正下线,都需要单独核对。以下做法适用于需要在合同中约定该接口交付范围的场景,验收时统一使用测试稿,不拿正式内容试错。
先约定凭证范围与调用边界
合同或附件里应写清接口凭证的种类和用途,例如账号标识、密钥、令牌各自对应哪个渠道、哪个发布动作,是否允许调用删除或撤销接口。凭证由哪一方申请、放在哪个环境、交付时以何种方式移交,都要落到纸面。
验收前核对凭证是否只在测试环境使用,是否具备调用测试渠道的权限。若渠道方要求单独申请测试账号,应在交付清单中列明申请状态,未取得测试凭证时该项验收记为待定,而不是默认通过。
记录字段建议包括:凭证名称、对应渠道、授权动作范围、所在环境、提供方、核对日期。凭证本身不写入验收文档正文,只登记名称和状态。
字段校验用测试稿逐项比对
准备一份测试稿,字段值刻意设置可辨认的内容,例如标题带固定前缀、正文含特殊符号、分类选择非默认项。提交后到渠道侧查看实际展示,逐项比对标题、正文、分类、作者、时间等字段是否一致。
对必填字段缺失、超长文本、非法字符分别设计测试稿,观察接口返回的错误提示是否指向具体字段。错误提示含糊时,验收记录中写明实际返回内容,作为后续修改依据。
记录表可按字段一行:字段名、测试稿填写值、渠道展示值、是否一致、异常说明。这样核对不依赖记忆,也便于双方对差异达成一致。
图片与重复请求单独核对
图片要确认上传后是否可访问、尺寸和格式是否被渠道接受、封面图与正文图是否落在正确位置。用不同格式和不同大小的测试图各测一次,记录失败时的返回信息。
重复请求方面,对同一测试稿连续提交两次,观察渠道侧生成一条还是多条内容。若接口没有去重机制,应在合同附件中写明由哪一方负责防重,以及重复发生后如何处理。
撤销也要实测:对已提交的测试稿执行撤销或删除,确认渠道侧内容状态变化,并记录撤销后再次访问的结果。仅返回撤销成功但内容仍在,应记为未通过。
审核状态与接收成功分开记录
接口接收成功只说明请求被受理,不代表内容已公开发布。验收时应记录提交后的状态流转,例如待审核、审核中、已发布、被驳回,并注明各状态在渠道侧如何查看。
审核结果由渠道方决定,验收能核对的是状态是否被正确回传、驳回原因是否可读、失败后能否重新提交。把这些作为接口行为的一部分写入记录,避免把审核通过率写进交付承诺。
最终核对方法是:用测试稿走完提交到撤销的完整路径,形成一份含时间、操作、返回内容、渠道侧实际状态的记录,双方确认后作为该项验收依据。
