请求与鉴权
从开发者控制台取得 API Key,通过 QL-Key 请求头携带。当前业务接口使用 JSON 请求体,并用 appid 指定已接入的企业微信实例。
响应判断
能力层一般返回 code、message、time 与 data 等字段。HTTP 200 代表网关返回了响应,但业务是否成功仍以 code=0 为准。配置回调地址属于青鸾自有接口,会额外返回 ok 和 request_id。
从哪个接口开始
建议先用查询连接状态或查询账号资料验证鉴权和实例归属,再接入消息、联系人、群聊等业务接口。调用参数应从当前接口目录或交互式文档读取。
建议实施步骤
- 创建 API Key。
- 接入企业微信账号并取得 appid。
- 调用查询类接口验证鉴权与实例。
- 接入业务动作并按 code=0 处理成功。
- 需要接收事件时再配置回调和验签。
常见问题
当前 API 路径前缀是什么?
当前公开接口位于 /qingluan/**,完整路径请从当前接口目录查看。
为什么 HTTP 200 还要判断 code?
HTTP 状态表示传输和网关响应情况,能力层的业务结果由 code 表达;code=0 才是业务成功。