把接口设计成“可独立验收的交付物”而不是“等对方动手”:先划清哪些动作必须由供应商在文档里定义清楚(字段、触发条件、异常返回值),哪些动作由你方执行并回传结果。缺少完整数据或权限时,最小可执行动作是要求供应商提供一份可替换的配置样例和一份失败回滚说明,据此决定是继续按文档对接,还是把实施责任写回合同再谈。
供应商只交文档,通常落在两种性质完全不同的合作上,接口设计也随之分叉。
区分依据不看文档厚薄,而看三个可查证的点:文档是否包含可直接执行的参数(如账户结构、转化事件定义、URL参数规则);是否说明失败时由谁改、改完回传给谁;是否约定了你方执行后对方需要确认的时限。三点都缺,基本属于条件B被包装成条件A。
如果实施确实在你方,接口设计的目标是让文档能被不同执行人重复使用,而不是依赖供应商口头补充。
要求供应商提供一份最小配置样例:以推广落地页与转化跟踪为例,文档应给出可复制的参数结构,例如 <a href="?utm_source=partner&utm_medium=doc"> 这类占位示例,并说明每个参数由谁填写、填错会导致什么现象。你方按样例在一个测试页面或测试广告组执行一次,记录结果:参数是否被正确读取、转化事件是否触发、异常时页面是否仍可访问。
这个动作的结果直接决定下一步:如果测试通过,说明文档具备独立实施条件,可以按文档推进并只保留变更沟通接口;如果测试失败且原因在文档缺失,就应把缺失项列成清单退回供应商补充,而不是自行猜测补全,否则后续出问题无法归因。
例外情况:当文档涉及你方没有权限的系统(如供应商自有投放账户、第三方数据平台),你无法完成测试。此时最小动作是要求对方提供只读权限或脱敏截图,并注明假设——你只能验证字段逻辑,不能验证真实执行效果,这个结论不能推出“方案一定有效”。
当实施本应属于供应商,接口要围绕“谁动手、何时回传、不回传怎么办”来写。
实际动作示例(假设场景):你方与供应商约定,对方在收到素材后三个工作日内回传一份“已执行项与未执行项”清单。若清单显示某项因缺少转化代码权限未执行,你方下一步不是催进度,而是先补权限或改由你方嵌入代码,再要求对方确认。这样接口把“文档”和“实施”串成一条可追踪的链,而不是两张互不相干的纸。
无论哪种条件,验收信号都应落在可观察的行为上,而不是文档篇幅或承诺措辞。
需要提醒的是:请求量、抓取量或某项统计归零,不能单独证明接口设计正确。归零还可能来自权限未生效、测试环境隔离、统计口径变更或对方尚未执行。只有结合执行记录和复现结果,才能判断问题出在接口定义还是执行环节。
如果供应商坚持只交文档、拒绝任何回传或确认动作,而合同又约定其负责实施,这本身就是接口设计失败的信号——此时应回到合同层面明确交付物形态,而不是在文档里继续追加说明。