JS-SDK 接口

class wechatpy.client.api.WeChatJSAPI(client=None)[源代码]
get_jsapi_add_card_params(card_id: str, code: str = '', openid: str = '', fixed_begintimestamp: Optional[int] = None, outer_str: str = '', nonce_str: str = '', timestamp: int = 0, card_ticket: str = '') → wechatpy.schemes.JsApiCardExt[源代码]

用于生成 jsapi 批量添加卡券接口的 cardList 参数中的 cardExt 参数 参数意义见微信文档地址:

参数:
  • card_id – 卡券ID. 一个卡券ID对应一类卡券, 包含了相应库存数量的Code码.
  • code – 卡券Code码. 一张卡券的唯一标识, 核销卡券时使用此串码, 支持商户自定义.
  • openid – 用户在该公众号下的唯一身份.
  • fixed_begintimestamp – 卡券在第三方系统的实际领取时间, 为东八区时间戳 (UTC+8,精确到秒) . 当卡券的有效期类型为 DATE_TYPE_FIX_TERM 时专用, 标识卡券的实际生效时间, 用于解决商户系统内起始时间和领取时间不同步的问题.
  • outer_str – 领取渠道参数, 用于标识本次领取的渠道值. 支持商户自定义场景值填入card_ext进行卡券投放, 当用户领取时会将相应场景值通过事件通知商户.
  • nonce_str – 随机字符串, 由开发者设置传入, 加强安全性 (若不填写可能被重放请求).
  • timestamp – unix 时间戳, 不同添加请求的时间戳须动态生成, 若重复将会导致领取失败.
  • card_ticket – 用于卡券的微信 api_ticket
返回:

卡券的附加信息 card_ext 的 dict

get_jsapi_card_ticket()[源代码]

获取 api_ticket:是用于调用微信卡券JS API的临时票据, 有效期为7200 秒, 通过access_token 来获取. 微信文档地址:https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#62 该方法会通过 session 对象自动缓存管理 ticket

返回:ticket
get_jsapi_signature(noncestr, ticket, timestamp, url)[源代码]

获取 JSAPI 签名

参数:
  • noncestr – nonce string
  • ticket – JS-SDK ticket
  • timestamp – 时间戳
  • url – URL
返回:

签名

get_jsapi_ticket()[源代码]

获取微信 JS-SDK ticket

该方法会通过 session 对象自动缓存管理 ticket

返回:ticket
get_ticket(type='jsapi')[源代码]

获取微信 JS-SDK ticket

返回:返回的 JSON 数据包