使用指南
先核版本与认证,再核请求与响应
确认部署版本与认证方式
先确认实际部署的 PsCMS 版本、服务地址和认证方式。文档中的接口与参数需要对照该部署版本,地址及示例字段不能直接作为项目配置。
- 准备资料
- 部署版本、接口启用范围、测试环境与授权联系人。
核对请求和返回结构
按业务对象定位接口,核对路径、请求方法、参数位置、类型、必填项和返回字段。将文档与当前接口的差异记录到对接清单。
- 关注事项
- 字段含义、状态码、权限不足和其他错误的处理方式。
在授权环境中验证
使用获准的测试账号和数据,核对正常返回、权限边界与失败情况。确认网络与部署配置后,再约定双方的联调步骤。
- 联调前确认
- 接口负责人、可测试时间、允许执行的操作和预期响应。
带着接口问题,讨论对接安排
提供部署版本、需要对接的系统和待确认的接口问题。认证凭据通过双方约定的安全方式配置,咨询内容中无需填写密码或密钥。
