开放平台
取消
开发者平台
中文
EN
取消
  • 平台指南

    • # 接口报错诊断

    # 概述

    微信开发者平台 「接口中心」 旨在为开发者提供统一的接口使用、调试和诊断服务。接口中心整合了原有的"API调试"和"消息推送调试"，帮助开发者快速定位和解决API调用过程中遇到的问题。

    「接口中心」目前包含 「接口报错诊断」 和 「更多调试能力」 （接口报错诊断、调试消息推送、调试服务号接口），更多调试能力均需跳转使用

    「接口报错诊断」 在开发者平台内实现，通过填写 rid 信息或包含 rid 的返回包，可诊断 API 接口问题。

    rid 指代在处理一次 API 请求时生成的 “唯一请求标识符”（Request ID），用于标记并追踪这次请求。（服务端 API 调用出错必然会返回该值）

    # 操作指南

    # 1、访问路径

    接口中心位于「微信开发者平台 - 控制台首页 - 开发工具」模块，在开发工具列表中点击 「接口中心」 入口

    image.png

    # 2、更多调试能力

    「接口中心」还整合了调试API、调试消息推送、调试服务号接口等能力，开发者点击后将跳转至微信开放平台调试工具进行后续操作。

    image.png

    # 3、接口报错诊断指南

    开发者可以在「接口中心」使用 「接口报错诊断」 功能定位接口问题，获取请求接口的基础信息、请求信息、调用分析。

    image.png

    使用步骤如下：

    # 第一步：输入rid信息

    在接口中心页面的 “接口报错诊断” 输入rid信息，目前支持两种输入方式：

    • 直接输入rid ：如果已经获得了具体的rid值，可以直接将其粘贴到输入框中。系统会自动识别并验证rid的格式。

    • 输入包含rid的返回包 ：如果开发者有完整的API返回包，可以将整个返回包内容粘贴到输入框中。系统会自动解析并提取其中的 第一个rid值 。

    # 第二步：执行诊断

    点击"开始诊断"按钮后，系统会自动匹配 rid 值。

    • 如果未匹配到相关信息，需确保 rid 正确，如无法匹配到可复现后取最新 rid 重新诊断。

    • 如果匹配到对应rid，会立即开始进行分析。

    # 第三步：查看诊断结果

    诊断完成后，页面会根据查询结果和账户权限显示相应的信息。

    结果展示分为以下几种情况：

    # 1）查询成功且有权限查看
    image.png

    若当前账号是 rid 对应调用账号的管理员或开发者时，会显示完整的诊断信息，包括：

    基本信息部分：

    • 调用账号 ：显示发起请求的账号昵称、头像和类别标签。对于第三方平台代调用的情况，会同时显示第三方平台信息和被代调用的小程序或公众号信息。开发者点击 “账号详情” 后会在微信开发者平台内跳转到该账号详情页面。

    • 接口地址 ：被调用的API接口路径，以"/"开头，开发者可以点击“接口文档”查看该接口的详情

    • 接口适用范围 ：该接口允许调用的账号类型

    • 其他的信息包括 ：账号类型、AppID、请求 rid、调用时间、接口功能描述

    请求信息部分 ：

    • 服务端耗时 ：接口在微信服务器端的处理时间，帮助判断性能问题

    • 调用IP地址 ：发起请求的调用方IP地址（开发者端）

    • HTTP状态码 ：请求的HTTP响应状态码

    • UA信息 ：请求时的User-Agent信息，包含客户端环境信息

    • 请求包 ：完整的请求参数，以JSON格式高亮显示。

    • 响应包 ：完整的响应数据，以JSON格式高亮显示

    调用分析部分 ：

    • 业务错误码 ：请求返回的具体业务错误码

    • 错误描述 ：错误码对应的详细描述信息

    • 解决方案 ：针对该错误码的具体解决建议和操作指导

    # 2）查询成功但权限不符
    image.png

    当前登录账号如不具备该 RID 关联账号的管理员或开发者权限，系统只会显示脱敏信息

    脱敏信息展示 ：系统会隐藏敏感信息（调用账号），只显示基本的接口调用概况，如接口地址、调用时间等非敏感信息。

    # 3）查询成功但无关联账号

    当 rid 没有关联的账号信息时，系统会显示脱敏信息进行提示。这种情况通常发生在开发者发送请求时未填写正确的AppId。

    # 4）查询失败或RID过期

    当系统无法找到对应的 rid 信息或 rid 已过期时（有效期为7天）会触发。

    开发者需要确保 rid 正确，如无法匹配到可复现后取最新 rid 重新诊断。

    # 特殊情况：第三方平台代调用
    • 第三方平台代调用指的是，在得到公众号或小程序等账号的管理员授权后，第三方服务商通过「第三方平台账号」代调用官方接口。

    对于第三方平台代小程序或公众号调用的情况，接口中心提供了更多的信息展示和权限管理：

    • 调用身份展示：页面会清晰地显示调用关系，包括第三方平台信息和被代调用的身份账号信息。

    • 权限隔离原则：遵循 “调用时的token谁造的，就应该谁来查看” 的原则。例如，第三方平台代小程序/公众号调用，那么，第三方平台的管理员无权限进入公众号/小程序详情页，只能进入第三方平台账号的详情页。。

    image.png