先确定数据流和动作流
数据流回答“哪些事件需要进入你的系统”,动作流回答“你的系统需要发起哪些企业微信操作”。先明确这两类需求,再选择消息、联系人、群聊、朋友圈或文件接口。
用公开契约约束实现
当前公开接口路径以 /qingluan/ 开头,请求头携带 QL-Key,请求体用 appid 指定实例。字段类型、必填项和示例应直接以公开 OpenAPI 为准。
把业务失败与网络失败分开
能力层即使返回 HTTP 200,仍需读取业务字段 code;只有 code=0 才表示业务成功。应用还应分别处理鉴权失败、实例不存在、请求超时和业务错误。
建议实施步骤
- 列出需要接收的事件和需要执行的动作。
- 创建 API Key,接入实例并保存 appid。
- 先打通一个只读接口,再接入写操作。
- 配置回调、完成验签,并记录必要的业务追踪信息。
常见问题
接口支持哪些开发语言?
接口使用标准 HTTP/JSON,可从能够发送 HTTP 请求的开发语言调用。
现行实例字段是什么?
现行字段是 appid,可在开发者控制台的实例与回调页面取得。