微信小游戲開(kāi)發(fā)文檔-小游戲獲取二維碼開(kāi)放能力開(kāi)發(fā)

2018-01-18 16:30 更新

獲取二維碼


小游戲的二維碼與小程序有著相同的樣式和獲取方式。通過(guò)后臺(tái)接口可以獲取小游戲的二維碼,掃描該二維碼可以直接進(jìn)入小游戲。目前微信支持兩種二維碼,小程序碼(左),小程序二維碼(右),如下所示:

微信小游戲開(kāi)發(fā)文檔獲取二維碼教程

獲取小程序碼

我們推薦生成并使用小程序碼,它具有更好的辨識(shí)度。目前有兩個(gè)接口可以生成小程序碼,開(kāi)發(fā)者可以根據(jù)自己的需要選擇合適的接口。

接口A: 適用于需要的碼數(shù)量較少的業(yè)務(wù)場(chǎng)景 接口地址:

https://api.weixin.qq.com/wxa/getwxacode?access_token=ACCESS_TOKEN

獲取 access_token 詳見(jiàn)文檔

POST 參數(shù)說(shuō)明

參數(shù) 類(lèi)型 默認(rèn)值 說(shuō)明
path String 不能為空,最大長(zhǎng)度 128 字節(jié)。小游戲沒(méi)有頁(yè)面的概念,因此將 query 以 ?a=b&c=d 形式傳給此參數(shù)
width Int 430 二維碼的寬度
auto_color Bool false 自動(dòng)配置線條顏色,如果顏色依然是黑色,則說(shuō)明不建議配置主色調(diào)
line_color Object {"r":"0","g":"0","b":"0"} auth_color 為 false 時(shí)生效,使用 rgb 設(shè)置顏色 例如 {"r":"xxx","g":"xxx","b":"xxx"}

注意:通過(guò)該接口生成的小程序碼,永久有效,數(shù)量限制見(jiàn)文末說(shuō)明,請(qǐng)謹(jǐn)慎使用。用戶掃描該碼進(jìn)入小程序后,將直接進(jìn)入 path 對(duì)應(yīng)的頁(yè)面。

接口B:適用于需要的碼數(shù)量極多,或僅臨時(shí)使用的業(yè)務(wù)場(chǎng)景

接口地址:

https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN

獲取 access_token 詳見(jiàn)文檔

POST 參數(shù)說(shuō)明

參數(shù) 類(lèi)型 默認(rèn)值 說(shuō)明
scene String 最大32個(gè)可見(jiàn)字符,只支持?jǐn)?shù)字,大小寫(xiě)英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~,其它字符請(qǐng)自行編碼為合法字符(因不支持%,中文無(wú)法使用 urlencode 處理,請(qǐng)使用其他編碼方式)
width Int 430 二維碼的寬度
auto_color Bool false 自動(dòng)配置線條顏色,如果顏色依然是黑色,則說(shuō)明不建議配置主色調(diào)
line_color Object {"r":"0","g":"0","b":"0"} auto_color 為 false 時(shí)生效,使用 rgb 設(shè)置顏色 例如 {"r":"xxx","g":"xxx","b":"xxx"}

注意:通過(guò)該接口生成的小程序碼,永久有效,數(shù)量暫無(wú)限制。用戶掃描該碼進(jìn)入小程序后,開(kāi)發(fā)者需在對(duì)應(yīng)頁(yè)面獲取的碼中 scene 字段的值,再做處理邏輯。使用如下代碼可以獲取到二維碼中的 scene 字段的值。調(diào)試階段可以使用開(kāi)發(fā)工具的條件編譯自定義參數(shù) scene=xxxx 進(jìn)行模擬,開(kāi)發(fā)工具模擬時(shí)的 scene 的參數(shù)值需要進(jìn)行 urlencode

// 這是首頁(yè)的 js
Page({
  onLoad: function(options) {
    // options 中的 scene 需要使用 decodeURIComponent 才能獲取到生成二維碼時(shí)傳入的 scene
    var scene = decodeURIComponent(options.scene)
  }
})

獲取小程序二維碼

接口 C:適用于需要的碼數(shù)量較少的業(yè)務(wù)場(chǎng)景

接口地址:

https://api.weixin.qq.com/cgi-bin/wxaapp/createwxaqrcode?access_token=ACCESS_TOKEN

獲取 access_token 詳見(jiàn) 文檔

POST 參數(shù)說(shuō)明

參數(shù) 類(lèi)型 默認(rèn)值 說(shuō)明
path String 不能為空,最大長(zhǎng)度 128 字節(jié)。小游戲沒(méi)有頁(yè)面的概念,因此將 query 以 ?a=b&c=d 形式傳給此參數(shù)
width Int 430 二維碼的寬度

注意:通過(guò)該接口生成的小程序二維碼,永久有效,數(shù)量限制見(jiàn)文末說(shuō)明,請(qǐng)謹(jǐn)慎使用。

示例:

{
    "path": "?query=1", 
    "width": 430
}

Bug & Tip

  1. tip:通過(guò)該接口,僅能生成已發(fā)布的小程序的二維碼。
  2. tip:可以在開(kāi)發(fā)者工具預(yù)覽時(shí)生成開(kāi)發(fā)版的帶參二維碼。
  3. tip:接口 A 加上接口 C,總共生成的碼數(shù)量限制為 100,000,請(qǐng)謹(jǐn)慎調(diào)用。
  4. tip: POST 參數(shù)需要轉(zhuǎn)成 json 字符串,不支持 form 表單提交。
  5. tip: auto_color line_color 參數(shù)僅對(duì)小程序碼生效。


以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)