开放平台接口设计 - 969251639/study GitHub Wiki

开放平台接口,顾名思义,对外开放api,合作者可以通过一定的协议来调用

流程

  1. 开通账号

  2. 接口激活

合作伙伴通过检验signature对请求进行校验(下面有校验方式)。若确认此次GET请求来自开放平台服务器,请原样返回echostr参数内容,则接入生效,数据推送功能激活成功,后续便能成功接收开放平台数据推送。否则接入失败,开放平台不会向合作伙伴推送数据。加密/校验流程如下:

1)将token、timestamp、nonce三个参数进行字典序排序
2)将三个参数字符串拼接成一个字符串进行MD5(32位)加密
3、将加密后的字符串大写
4)将获得的字符串与signature对比,标识该请求来源于开放平台服务器

预警机制

预警概述 1、开放平台向合作伙伴推送数据时,如失败次数达到预定阀值,开放平台会停止数据推送。
2、合作伙伴如发现开放平台停止了数据推送,可调用数据推送激活接口,如成功调用,开放平台判定合作伙伴服务器恢复运行正常,会再次开启数据推送。
3、合作伙伴开发者可调用预警信息接口,获取具体错误信息,用于排查。

  • 阀值定义
    从第一次推送失败算起,累计失败次数达到1000次。
    如连续失败少于1000次(如第998次)后一次(如第999次)请求成功,则计数重新开始累计。

  • 预警类型
    类型 描述
    DNS失败 开放平台向合作伙伴推送数据时,解析DNS失败
    DNS超时 开放平台向合作伙伴推送数据时,解析DNS超时,超时时间为5秒
    连接超时 开放平台连接合作伙伴服务器时发生超时,超时时间为5秒
    请求超时 开放平台向合作伙伴服务器推送数据后,合作伙伴服务器5秒内没有返回
    回应失败 开放平台向合作伙伴服务器推送数据后,得到的回应不合法