WXAPI · 微信

[TOC] ## wx.login(OBJECT) [【官方說明】](https://developers.weixin.qq.com/miniprogram/dev/api/api-login.html#wxloginobject) * **一般性說明**：小程序的Client（C端的js文件里的代碼）向WX的Server發送request，得到response的信息。request不需指定URL。 * **主要結構** ~~~JavaScript wx.login({ timeout: 2000, //ms success({errMsg: ' ', code: ' '}){ ...... }, fail({...}){ ......} }) ~~~ * **作用** 1. 小程序調用wx.login() 獲取 **`臨時登錄憑證code`** ，并回傳到開發者服務器。 2. 開發者服務器以code換取 `用戶唯一標識openid` 和 `會話密鑰session_key`。 3. 之后開發者服務器可以根據用戶標識來生成自定義登錄態，用于后續業務邏輯中前后端交互時識別用戶身份。 ## wx.getUserInfo(OBJECT) [【官方說明】](https://developers.weixin.qq.com/miniprogram/dev/api/open.html) * **一般性說明**：小程序的Client（C端的js文件里的代碼）向WX的Server發送request，得到response的信息。request不需指定URL。 * **主要結構** ~~~JavaScript wx.getUserInfo({ timeout: 2000, //ms success({userInfo:{...}, rawData: Str, signature: Str, encryptedData: Str, iv: Str}){ ...... }, fail({...}){ ......} }) ~~~ * **使用注意** 1. 使用` <button open-type="getUserInfo"></button>` 引導用戶主動進行授權操作 2. 當用戶未授權過，調用該接口將直接報錯 3. 當用戶授權過，可以使用該接口獲取用戶信息 * **`userInfo`參數說明**： ~~~JavaScript //userInfo結構示例 userInfo:{nickName: Str, avatarUrl: Str, gender: Num, city: Str, province: Str, country: Str, language: Str} }) ~~~ | 參數 | 類型 | 說明 | | --- | --- | --- | | nickName | String | 用戶昵稱 | | avatarUrl | String | 用戶頭像，最后一個數值代表正方形頭像大小（有0、46、64、96、132數值可選，0代表132\*132正方形頭像），用戶沒有頭像時該項為空。若用戶更換頭像，原有頭像URL將失效。| | gender | String | 用戶的性別，值為1時是男性，值為2時是女性，值為0時是未知 | | city | String | 用戶所在城市 | | province | String | 用戶所在省份| | country | String | 用戶所在國家| | language | String | 用戶的語言，簡體中文為zh_CN| ## wx.request(OBJECT) [【官方說明】](https://developers.weixin.qq.com/miniprogram/dev/api/network-request.html) * **一般性說明**：小程序的Client（C端的js文件里的代碼）向小程序的Server發送request，得到response的信息。request必須需指定URL。 * **主要結構** ~~~JavaScript wx.request({ url: Str, data: Obj/Str/Arr, header: Obj, method: Cons, //OPTIONS, GET(默認值), HEAD, POST, PUT, DELETE, TRACE, CONNECT dataType: Str, //json(默認) 如果設為json，會嘗試對返回的數據做一次 JSON.parse responseType: Str/Arr,//設置響應的數據類型。合法值：text、arraybuffer success({data: Obj/Str/Arr, statusCode: Num, header: {...}}){ ...... }, fail({...}){ ......} }) ~~~ `tip`：header中的content-type 默認為 'application/json'; ## 關于小程序中網絡相關API的說明 [【官方說明】](https://developers.weixin.qq.com/miniprogram/dev/api/api-network.html) 網絡API列表： | API | 說明 | |--- |--- | | wx.request | 發起網絡請求| | wx.uploadFile | 上傳文件| | wx.downloadFile | 下載文件| | wx.connectSocket | 創建 WebSocket 連接| | wx.onSocketOpen | 監聽 WebSocket 打開| | wx.onSocketError | 監聽 WebSocket 錯誤| | wx.sendSocketMessage | 發送 WebSocket 消息| | wx.onSocketMessage | 接受 WebSocket 消息| | wx.closeSocket | 關閉 WebSocket 連接| | wx.onSocketClose | 監聽 WebSocket 關閉| 在小程序中使用網絡相關的 API 時，需要注意下列問題，請開發者提前了解。 1. 服務器域名配置每個微信小程序需要事先設置一個通訊域名，小程序可以跟指定的域名與進行網絡通信。包括普通 HTTPS 請求（`request`）、上傳文件（`uploadFile`）、下載文件（`downloadFile`) 和 WebSocket 通信（`connectSocket`） **配置流程** 服務器域名請在 `小程序后臺-設置-開發設置-服務器域名` 中進行配置，配置時需要注意： * 域名只支持 https (`request`、`uploadFile`、`downloadFile`) 和 wss (`connectSocket`) 協議； * 域名不能使用 IP 地址或 localhost * 域名必須經過 ICP 備案； * 出于安全考慮，`api.weixin.qq.com` 不能被配置為服務器域名，相關API也不能在小程序內調用。 * 開發者應將 `appsecret` 保存到后臺服務器中，通過服務器使用 `appsecret` 獲取 `accesstoken`，并調用相關 API。 * 對于每個接口，分別可以配置最多 20 個域名 **HTTPS 證書** 小程序必須使用 HTTPS 請求。小程序內會對服務器域名使用的 HTTPS 證書進行校驗，如果校驗失敗，則請求不能成功發起。由于系統限制，不同平臺對于證書要求的嚴格程度不同。為了保證小程序的兼容性，建議開發者按照最高標準進行證書配置，并使用相關工具檢查現有證書是否符合要求。 * HTTPS 證書必須有效。證書必須被系統信任，部署SSL證書的網站域名必須與證書頒發的域名一致，證書必須在有效期內; * iOS 不支持自簽名證書; * iOS 下證書必須滿足蘋果[ App Transport Security (ATS)](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW33) 的要求; * TLS 必須支持 1.2 及以上版本。部分舊 Android 機型還未支持 TLS 1.2，請確保 HTTPS 服務器的 TLS 版本支持1.2及以下版本; * 部分 CA 可能不被操作系統信任，請開發者在選擇證書時注意小程序和各系統的相關通告。 [Chrome 56/57 內核對 WoSign、StartCom 證書限制周知](https://developers.weixin.qq.com/community/develop/doc/800026caeb042e45681583652b70910a) **跳過域名校驗** 在微信開發者工具中，可以臨時開啟開發環境不校驗請求域名、TLS版本及HTTPS證書選項，跳過服務器域名的校驗。此時，在微信開發者工具中及手機開啟調試模式時，不會進行服務器域名的校驗。 **在服務器域名配置成功后，建議開發者關閉此選項進行開發，并在各平臺下進行測試，以確認服務器域名配置正確。** > 如果手機上出現 “打開調試模式可以發出請求，關閉調試模式無法發出請求” 的現象，請確認是否跳過了域名校驗，并確認服務器域名和證書配置是否正確。 2. 關于請求 * 默認超時時間和最大超時時間都是 60s * `request`、`uploadFile`、`downloadFile` 的最大并發限制是 10 個 * 網絡請求的 referer header 不可設置。其格式固定為 `https://servicewechat.com/{appid}/{version}/page-frame.html`，其中 `{appid}` 為小程序的 appid，`{version}` 為小程序的版本號，版本號為 0 表示為開發版、體驗版以及審核版本，版本號為 devtools 表示為開發者工具，其余為正式版本。 * 小程序進入后臺運行后（非置頂聊天），如果 5s 內網絡請求沒有結束，會回調錯誤信息 fail `interrupted`；在回到前臺之前，網絡請求接口調用都會無法調用。 3. 關于服務器返回 **返回值編碼** * 建議服務器返回值使用 UTF-8 編碼。對于非 UTF-8 編碼，小程序會嘗試進行轉換，但是會有轉換失敗的可能。 * 小程序會自動對 BOM 頭進行過濾。 **回調** * 只要成功接收到服務器返回，無論statusCode是多少，都會進入success回調。請開發者根據業務邏輯對返回值進行判斷。 ## 接口調用憑證`access_token` `access_token` 是全局唯一接口調用憑據，開發者調用各接口時都需使用 access_token，請妥善保存。access_token 的存儲至少要保留512個字符空間。access_token 的有效期目前為2個小時，需定時刷新，重復獲取將導致上次獲取的 access_token 失效。 [【官方說明】](https://developers.weixin.qq.com/miniprogram/dev/api/token.html) 開發者可以使用 AppID 和 AppSecret 調用本接口來獲取 access_token。AppID 和 AppSecret 可登錄微信公眾平臺官網-設置-開發設置中獲得（需要已經綁定成為開發者，且帳號沒有異常狀態）。 AppSecret 生成后請自行保存，因為在公眾平臺每次生成查看都會導致 AppSecret 被重置。注意調用所有微信接口時均需使用 https 協議。如果第三方不使用中控服務器，而是選擇各個業務邏輯點各自去刷新 access_token，那么就可能會產生沖突，導致服務不穩定。接口地址： `https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=APPID&secret=APPSECRET` ## How To ?? ### C端掃描二維碼（向S端發送信息）后，S端將處理結果推送到C端？ webSocket？ ### 管理員在C端進行操作后，S端將處理結果推送到有關的C端？ webSocket？