一、簡介
getwxacodeunlimit介面是微信提供的一個小程序生成碼的API,也就是生成微信小程序的二維碼。在使用getwxacodeunlimit時,只需要傳入需要生成二維碼的小程序碼參數,並返回對應的微信小程序碼URL,支持BMP、JPEG、PNG三種格式生成。這個介面可以進一步幫助開發人員營銷、普及或者推廣小程序。
二、使用方法
要使用getwxacodeunlimit生成二維碼,需要將scene參數傳遞到API中。scene參數是一個字元串,最大長度為32個字元(不傳默認為空字元串),用於攜帶業務數據,例如小程序碼中包含的產品信息、其他參數信息等。使用該介面還需滿足以下條件:
(1)介面需要使用小程序的AppID和AppSecret進行授權;
(2)調用該介面的賬號需要有小程序的碼管理許可權。
下面是調用getwxacodeunlimit的代碼示例:
const wxRequest = require('request'); const qs = require('qs'); const appid = 'wx35423aa6e7a96af7'; const secret = '30f06ce1c18d211b69f45e657d051a8c'; const scene = 'a=1&b=2'; const apiURL = "https://api.weixin.qq.com/cgi-bin/wxaapp/createwxaqrcode?access_token="; const params = { 'access_token': '', 'path': 'pages/index/index', 'width': 280, 'auto_color': true, 'line_color': '{ "r":0, "g":0, "b":0 }', 'is_hyaline': false }; const getAccessToken = () => { return new Promise((resolve, reject) => { const url = `https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=${appid}&secret=${secret}`; wxRequest.get(url, (err, res, body) => { if (err) { reject(err); return; } const token = JSON.parse(body).access_token; resolve(token); }); }); } getAccessToken().then((token) => { const requestURL = apiURL + token; params.scene = scene; wxRequest.post({ url: requestURL, encoding: null, json: params }, (err, res, body) => { const base64Img = Buffer.from(body).toString('base64'); resolve(base64Img); }); });
三、參數說明
調用getwxacodeunlimit介面時,需要傳遞以下參數,下面一一進行解析:
1、access_token:小程序的AccessToken,需要對小程序進行授權才能獲取。
2、path:小程序的頁面路徑(必須是已經發布的小程序頁面路徑),使用”/”分隔,不能攜帶參數(參數請放在scene中)。
3、scene:小程序的碼參數,最大長度為32個字元,不能包含特殊字元(例如 #,& 等)。
4、width:二維碼的寬度,單位為像素,最小為280px,最大為1280px。
5、auto_color:是否自動設置線條的顏色(true 或 false)。
6、line_color:線條的顏色,auto_color 為 false 時必須設置線條顏色值。顏色值使用 RGB 格式,例如 {“r”:”0″,”g”:”0″,”b”:”0″} 表示黑色。
7、is_hyaline:是否需要透明底色(true 或 false)。
四、注意事項
在使用getwxacodeunlimit生成微信小程序碼時,需要注意以下幾點:
1、獲取access_token。 請求API時,必須向微信伺服器發送 AccessToken,獲取AccessToken需要通過訪問微信的獲取Token API。Token的獲取需要提供appid和secret,系統會返回Token、Token有效時間;
2、生成的小程序碼有有效期。生成的小程序碼有時效性,有效時長由調用介面時傳入的expire_seconds參數決定,默認為30秒,最大不超過2592000秒(即30天);
3、避免相同參數生成不同的微信小程序碼。 如果以相同的scene參數調用getwxacodeunlimit介面,返回的值不變;反之亦然。如果需要帶參數的二維碼,傳入的scene參數不同,生成的二維碼URL也是不同的;
4、兼容性問題。微信小程序碼的兼容性還需要與具體的場景進一步考驗。所以,開發人員應該在實際運用場景中進行充分測試,遺漏了再處理。
五、總結
從本文中我們了解了微信小程序碼API——getwxacodeunlimit,其是微信小程序的二維碼編碼生成器的核心。我們也詳細地闡明了API的使用方法和各參數的意義,以及使用getwxacodeunlimit過程中需要注意的幾個問題。getwxacodeunlimit為小程序的推廣和普及提供了極大的便利性,獲得更多的用戶關注和共享。我們希望這篇文章能夠幫助開發人員更全面地了解微信小程序碼API的使用,取得更好的效果。
原創文章,作者:OOYAB,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/371086.html