【2018微信小程序最新API接口與插件大全】
【2018微信小程序最新API接口與插件大全】微信小程序API接口、微信小程序插件、微信小程序插件管理【珠海網(wǎng)站建設(shè)電話:400-000-1280】微信小程序開發(fā)者可通過以下接口管理插件,包括:添加、刪除、查詢已添加的插件,微信小程序插件開發(fā)者也可調(diào)用接口管理插件使用申請。
微信小程序API接口與插件大全
插件管理權(quán)限集用于第三方代小程序管理插件,具體包括:添加插件、查詢已添加的插件及刪除插件。具體接口列表如下:
1.申請使用插件
2.查詢已添加的插件
3.刪除已添加的插件
1.申請使用插件接口
此接口用于小程序向插件開發(fā)者發(fā)起使用插件的申請。
請求方式: POST(請使用https協(xié)議)
https://api.weixin.qq.com/wxa/plugin?access_token=TOKEN
POST數(shù)據(jù)示例
{ "action":"apply", "plugin_appid":"aaaa", }
參數(shù)說明
參數(shù) | 說明 |
---|---|
action | 填寫apply |
plugin_appid | 插件appid |
返回說明
{ "errcode":0, "errmsg":"ok", }
參數(shù)說明
參數(shù) | 說明 |
---|---|
errcode | 錯(cuò)誤碼 |
errmsg | 錯(cuò)誤信息 |
錯(cuò)誤碼說明
錯(cuò)誤碼 | 說明 |
---|---|
0 | 成功 |
-1 | 系統(tǒng)錯(cuò)誤 |
89236 | 該插件不能申請 |
89237 | 已經(jīng)添加該插件 |
89238 | 申請或使用的插件已經(jīng)達(dá)到上限 |
89239 | 該插件不存在 |
2. 查詢已添加的插件
此接口用于查詢小程序目前已添加的插件(包括確認(rèn)中、已通過、已拒絕、已超時(shí)狀態(tài))
請求方式: POST(請使用https協(xié)議)
https://api.weixin.qq.com/wxa/plugin?access_token=TOKEN
POST數(shù)據(jù)示例:
{ "action":"list", }
參數(shù)說明
參數(shù) | 說明 |
---|---|
action | 填寫list |
返回說明(正常時(shí)返回的json示例)
{ "errcode":0, "errmsg":"ok", "plugin_list":[ "appid":"aaaa", "status":1, "nickname":"插件昵稱", "headimgurl":"http://plugin.qq.com", ], }
參數(shù)說明
參數(shù) | 說明 |
---|---|
errcode | 錯(cuò)誤碼 |
errmsg | 錯(cuò)誤信息 |
plugin_list | 申請或使用中的插件列表 |
appid | 插件appid |
status | 插件狀態(tài)(1:申請中,2:申請通過,3:被拒絕;4:已超時(shí)) |
nickname | 插件昵稱 |
headimgurl | 插件頭像 |
錯(cuò)誤碼說明
錯(cuò)誤碼 | 說明 |
---|---|
0 | 成功 |
-1 | 系統(tǒng)錯(cuò)誤 |
3. 刪除已添加的插件
此接口用戶小程序刪除當(dāng)前已添加的插件(包括已通過和已拒絕)
請求方式: POST(請使用https協(xié)議)
https://api.weixin.qq.com/wxa/plugin?access_token=TOKEN
POST數(shù)據(jù)示例
{ "action":"unbind" "plugin_appid":"aaaa" }
參數(shù)說明
參數(shù) | 說明 |
---|---|
action | 填寫list |
plugin_appid | 插件appid |
返回說明(正常時(shí)返回的json示例)
{ "errcode":0, "errmsg":"ok", }
錯(cuò)誤碼說明
錯(cuò)誤碼 | 說明 |
---|---|
0 | 成功 |
-1 | 系統(tǒng)錯(cuò)誤 |
89243 | 該申請為“待確認(rèn)”狀態(tài),不可刪除 |
89244 |
不存在該插件appid |
下面對其進(jìn)行詳細(xì)介紹:
步驟1:第三方平臺(tái)方獲取預(yù)授權(quán)碼(pre_auth_code)
預(yù)授權(quán)碼是第三方平臺(tái)方實(shí)現(xiàn)授權(quán)托管的必備信息,可以通過本文
步驟2:引入用戶進(jìn)入授權(quán)頁
第三方平臺(tái)方可以在自己的網(wǎng)站:中放置“微信公眾號(hào)授權(quán)”或者“小程序授權(quán)”的入口,引導(dǎo)公眾號(hào)和小程序管理員進(jìn)入授權(quán)頁。
授權(quán)頁網(wǎng)址為:
https://mp.weixin.qq.com/cgi-bin/componentloginpage?component\_appid=xxxx&pre\_auth\_code=xxxxx&redirect\_uri=xxxx&auth\_type=xxx。
參數(shù) | 是否必填 | 參數(shù)說明 |
---|---|---|
component_appid | 是 | 第三方平臺(tái)方appid |
pre_auth_code | 是 | 預(yù)授權(quán)碼 |
redirect_uri | 是 | 回調(diào)URI |
auth_type | 否 | 要授權(quán)的帳號(hào)類型, 1則商戶掃碼后,手機(jī)端僅展示公眾號(hào)、2表示僅展示小程序,3表示公眾號(hào)和小程序都展示。如果為未制定,則默認(rèn)小程序和公眾號(hào)都展示。第三方平臺(tái)開發(fā)者可以使用本字段來控制授權(quán)的帳號(hào)類型。 |
步驟3:用戶確認(rèn)并同意登錄授權(quán)給第三方平臺(tái)方
用戶進(jìn)入第三方平臺(tái)授權(quán)頁后,需要確認(rèn)并同意將自己的公眾號(hào)或小程序授權(quán)給第三方平臺(tái)方,完成授權(quán)流程。
步驟4:授權(quán)后回調(diào)URI,得到授權(quán)碼(authorization_code)和過期時(shí)間
授權(quán)流程完成后,授權(quán)頁會(huì)自動(dòng)跳轉(zhuǎn)進(jìn)入回調(diào)URI,并在URL參數(shù)中返回授權(quán)碼和過期時(shí)間(redirect_url?auth_code=xxx&expires_in=600)
步驟5:利用授權(quán)碼調(diào)用公眾號(hào)或小程序的相關(guān)API
在得到授權(quán)碼后,第三方平臺(tái)方可以使用授權(quán)碼換取授權(quán)公眾號(hào)或小程序的接口調(diào)用憑據(jù)(authorizer_access_token,也簡稱為令牌),再通過該接口調(diào)用憑據(jù),按照公眾號(hào)開發(fā)者文檔或小程序開發(fā)文檔的說明,去調(diào)用公眾號(hào)或小程序相關(guān)API。
(能調(diào)用哪些API,取決于用戶將哪些權(quán)限集授權(quán)給了第三方平臺(tái)方,也取決于公眾號(hào)或小程序自身擁有哪些接口權(quán)限),使用JS SDK等能力。具體請見【公眾號(hào)第三方平臺(tái)的接口說明】
下面對各API和機(jī)制進(jìn)行介紹(特別注意,所有API調(diào)用需要驗(yàn)證調(diào)用者IP地址。只有在第三方平臺(tái)申請時(shí)填寫的白名單IP地址列表內(nèi)的IP地址,才能合法調(diào)用,其他一律拒絕):
功能 | API的作用 |
---|---|
1、推送component_verify_ticket | 出于安全考慮,在第三方平臺(tái)創(chuàng)建審核通過后,微信服務(wù)器 每隔10分鐘會(huì)向第三方的消息接收地址推送一次component_verify_ticket,用于獲取第三方平臺(tái)接口調(diào)用憑據(jù)。 |
2、獲取第三方平臺(tái)component_access_token | 第三方平臺(tái)通過自己的component_appid(即在微信開放平臺(tái)管理中心的第三方平臺(tái)詳情頁中的AppID和AppSecret)和component_appsecret,以及component_verify_ticket(每10分鐘推送一次的安全ticket)來獲取自己的接口調(diào)用憑據(jù)(component_access_token) |
3、獲取預(yù)授權(quán)碼pre_auth_code | 第三方平臺(tái)通過自己的接口調(diào)用憑據(jù)(component_access_token)來獲取用于授權(quán)流程準(zhǔn)備的預(yù)授權(quán)碼(pre_auth_code) |
4、使用授權(quán)碼換取公眾號(hào)或小程序的接口調(diào)用憑據(jù)和授權(quán)信息 | 通過授權(quán)碼和自己的接口調(diào)用憑據(jù)(component_access_token),換取公眾號(hào)或小程序的接口調(diào)用憑據(jù)(authorizer_access_token和用于前者快過期時(shí)用來刷新它的authorizer_refresh_token)和授權(quán)信息(授權(quán)了哪些權(quán)限等信息) |
5、獲?。ㄋ⑿拢┦跈?quán)公眾號(hào)或小程序的接口調(diào)用憑據(jù) | 通過authorizer_refresh_token來刷新公眾號(hào)或小程序的接口調(diào)用憑據(jù) |
6、獲取授權(quán)公眾號(hào)或小程序基本信息 | 在需要的情況下,第三方平臺(tái)可以獲取公眾號(hào)或小程序的帳號(hào)基本信息,包括帳號(hào)名、帳號(hào)類型等 |
7、獲取授權(quán)方的選項(xiàng)設(shè)置信息 | 在需要的情況下,第三方平臺(tái)可以獲取公眾號(hào)或小程序的選項(xiàng)設(shè)置,包括地理位置上報(bào)設(shè)置、語音識(shí)別開關(guān)設(shè)置、微信多客服功能開關(guān)設(shè)置 |
8、設(shè)置授權(quán)方的選項(xiàng)信息 | 在需要的情況下,第三方平臺(tái)可以修改上述公眾號(hào)或小程序的選項(xiàng)設(shè)置,包括地理位置上報(bào)設(shè)置、語音識(shí)別開關(guān)設(shè)置、微信多客服功能開關(guān)設(shè)置 |
9、推送授權(quán)相關(guān)通知 | 當(dāng)公眾號(hào)或小程序?qū)Φ谌竭M(jìn)行授權(quán)、取消授權(quán)、更新授權(quán)時(shí),將通過事件推送告訴開發(fā)者 |
接下來:代替公眾號(hào)或小程序調(diào)用接口 | 取在完成授權(quán)后,第三方平臺(tái)可通過公眾號(hào)或小程序的接口調(diào)用憑據(jù)(authorizer_access_token)來代替它調(diào)用接口,具體請見“代公眾號(hào)實(shí)現(xiàn)業(yè)務(wù)”和“代小程序?qū)崿F(xiàn)業(yè)務(wù)”文件夾中的內(nèi)容 |
1、推送component_verify_ticket協(xié)議
在第三方平臺(tái)創(chuàng)建審核通過后,微信服務(wù)器會(huì)向其“授權(quán)事件接收URL”每隔10分鐘定時(shí)推送component_verify_ticket。第三方平臺(tái)方在收到ticket推送后也需進(jìn)行解密(詳細(xì)請見【消息加解密接入指引】),接收到后必須直接返回字符串success。
POST數(shù)據(jù)示例
<xml> <AppId> </AppId> <CreateTime>1413192605 </CreateTime> <InfoType> </InfoType> <ComponentVerifyTicket> </ComponentVerifyTicket> </xml>
字段說明
字段名稱 | 字段描述 |
---|---|
AppId | 第三方平臺(tái)appid |
CreateTime | 時(shí)間戳 |
InfoType | component_verify_ticket |
ComponentVerifyTicket | Ticket內(nèi)容 |
注意:
component_verify_ticket的有效時(shí)間較component_access_token更長,建議保存最近可用的component_verify_ticket,在component_access_token過期之前使用該ticket進(jìn)行更新,避免出現(xiàn)因?yàn)閠icket接收失敗而無法更新component_access_token的情況。
2、獲取第三方平臺(tái)component_access_token
第三方平臺(tái)component_access_token是第三方平臺(tái)的下文中接口的調(diào)用憑據(jù),也叫做令牌(component_access_token)。每個(gè)令牌是存在有效期(2小時(shí))的,且令牌的調(diào)用不是無限制的,請第三方平臺(tái)做好令牌的管理,在令牌快過期時(shí)(比如1小時(shí)50分)再進(jìn)行刷新。
接口調(diào)用請求說明
http請求方式: POST(請使用https協(xié)議) https://api.weixin.qq.com/cgi-bin/component/api_component_token
POST數(shù)據(jù)示例:
{ "component_appid":"appid_value" , "component_appsecret": "appsecret_value", "component_verify_ticket": "ticket_value" }
請求參數(shù)說明
參數(shù) | 說明 |
---|---|
component_appid | 第三方平臺(tái)appid |
component_appsecret | 第三方平臺(tái)appsecret |
component_verify_ticket | 微信后臺(tái)推送的ticket,此ticket會(huì)定時(shí)推送,具體請見本頁的推送說明 |
返回結(jié)果示例
{"component_access_token":"61W3mEpU66027wgNZ_MhGHNQDHnFATkDa9-2llqrMBjUwxRSNPbVsMmyD-yq8wZETSoE5NQgecigDrSHkPtIYA", "expires_in":7200}
結(jié)果參數(shù)說明
參數(shù) | 說明 |
---|---|
component_access_token | 第三方平臺(tái)access_token |
expires_in | 有效期 |
3、獲取預(yù)授權(quán)碼pre_auth_code
該API用于獲取預(yù)授權(quán)碼。預(yù)授權(quán)碼用于公眾號(hào)或小程序授權(quán)時(shí)的第三方平臺(tái)方安全驗(yàn)證。
接口調(diào)用請求說明
http請求方式: POST(請使用https協(xié)議) https://api.weixin.qq.com/cgi-bin/component/api_create_preauthcode?component_access_token=xxx
POST數(shù)據(jù)示例:
{ "component_appid":"appid_value" }
請求參數(shù)說明
參數(shù) | 說明 |
---|---|
component_appid | 第三方平臺(tái)方appid |
返回結(jié)果示例
{"pre_auth_code":"Cx_Dk6qiBE0Dmx4EmlT3oRfArPvwSQ-oa3NL_fwHM7VI08r52wazoZX2Rhpz1dEw","expires_in":600}
結(jié)果參數(shù)說明
參數(shù) | 說明 |
---|---|
pre_auth_code | 預(yù)授權(quán)碼 |
expires_in | 有效期,為10分鐘 |
4、使用授權(quán)碼換取公眾號(hào)或小程序的接口調(diào)用憑據(jù)和授權(quán)信息
該API用于使用授權(quán)碼換取授權(quán)公眾號(hào)或小程序的授權(quán)信息,并換取authorizer_access_token和authorizer_refresh_token。 授權(quán)碼的獲取,需要在用戶在第三方平臺(tái)授權(quán)頁中完成授權(quán)流程后,在回調(diào)URI中通過URL參數(shù)提供給第三方平臺(tái)方。請注意,由于現(xiàn)在公眾號(hào)或小程序可以自定義選擇部分權(quán)限授權(quán)給第三方平臺(tái),因此第三方平臺(tái)開發(fā)者需要通過該接口來獲取公眾號(hào)或小程序具體授權(quán)了哪些權(quán)限,而不是簡單地認(rèn)為自己聲明的權(quán)限就是公眾號(hào)或小程序授權(quán)的權(quán)限。
接口調(diào)用請求說明
http請求方式: POST(請使用https協(xié)議) https://api.weixin.qq.com/cgi-bin/component/api_query_auth?component_access_token=xxxx
POST數(shù)據(jù)示例:
{ "component_appid":"appid_value" , "authorization_code": "auth_code_value" }
請求參數(shù)說明
參數(shù) | 說明 |
---|---|
component_appid | 第三方平臺(tái)appid |
authorization_code | 授權(quán)code,會(huì)在授權(quán)成功時(shí)返回給第三方平臺(tái),詳見第三方平臺(tái)授權(quán)流程說明 |
返回結(jié)果示例
{ "authorization_info": { "authorizer_appid": "wxf8b4f85f3a794e77", "authorizer_access_token": "QXjUqNqfYVH0yBE1iI_7vuN_9gQbpjfK7hYwJ3P7xOa88a89-Aga5x1NMYJyB8G2yKt1KCl0nPC3W9GJzw0Zzq_dBxc8pxIGUNi_bFes0qM", "expires_in": 7200, "authorizer_refresh_token": "dTo-YCXPL4llX-u1W1pPpnp8Hgm4wpJtlR6iV0doKdY", "func_info": [ { "funcscope_category": { "id": 1 } }, { "funcscope_category": { "id": 2 } }, { "funcscope_category": { "id": 3 } } ] }}
結(jié)果參數(shù)說明
參數(shù) | 說明 |
---|---|
authorization_info | 授權(quán)信息 |
authorizer_appid | 授權(quán)方appid |
authorizer_access_token | 授權(quán)方接口調(diào)用憑據(jù)(在授權(quán)的公眾號(hào)或小程序具備API權(quán)限時(shí),才有此返回值),也簡稱為令牌 |
expires_in | 有效期(在授權(quán)的公眾號(hào)或小程序具備API權(quán)限時(shí),才有此返回值) |
authorizer_refresh_token | 接口調(diào)用憑據(jù)刷新令牌(在授權(quán)的公眾號(hào)具備API權(quán)限時(shí),才有此返回值),刷新令牌主要用于第三方平臺(tái)獲取和刷新已授權(quán)用戶的access_token,只會(huì)在授權(quán)時(shí)刻提供,請妥善保存。 一旦丟失,只能讓用戶重新授權(quán),才能再次拿到新的刷新令牌 |
func_info | 授權(quán)給開發(fā)者的權(quán)限集列表,ID為1到26分別代表: 1、消息管理權(quán)限 2、用戶管理權(quán)限 3、帳號(hào)服務(wù)權(quán)限 4、網(wǎng)頁服務(wù)權(quán)限 5、微信小店權(quán)限 6、微信多客服權(quán)限 7、群發(fā)與通知權(quán)限 8、微信卡券權(quán)限 9、微信掃一掃權(quán)限 10、微信連WIFI權(quán)限 11、素材管理權(quán)限 12、微信搖周邊權(quán)限 13、微信門店權(quán)限 14、微信支付權(quán)限 15、自定義菜單權(quán)限 16、獲取認(rèn)證狀態(tài)及信息 17、帳號(hào)管理權(quán)限(小程序) 18、開發(fā)管理與數(shù)據(jù)分析權(quán)限(小程序) 19、客服消息管理權(quán)限(小程序) 20、微信登錄權(quán)限(小程序) 21、數(shù)據(jù)分析權(quán)限(小程序) 22、城市服務(wù)接口權(quán)限 23、廣告管理權(quán)限 24、開放平臺(tái)帳號(hào)管理權(quán)限 25、 開放平臺(tái)帳號(hào)管理權(quán)限(小程序) 26、微信電子發(fā)票權(quán)限 請注意: 1)該字段的返回不會(huì)考慮公眾號(hào)是否具備該權(quán)限集的權(quán)限(因?yàn)榭赡懿糠志邆洌?,請根?jù)公眾號(hào)的帳號(hào)類型和認(rèn)證情況,來判斷公眾號(hào)的接口權(quán)限。 |
5、獲?。ㄋ⑿拢┦跈?quán)公眾號(hào)或小程序的接口調(diào)用憑據(jù)(令牌)
該API用于在授權(quán)方令牌(authorizer_access_token)失效時(shí),可用刷新令牌(authorizer_refresh_token)獲取新的令牌。請注意,此處token是2小時(shí)刷新一次,開發(fā)者需要自行進(jìn)行token的緩存,避免token的獲取次數(shù)達(dá)到每日的限定額度。緩存方法可以參考:http://mp.weixin.qq.com/wiki/2/88b2bf1265a707c031e51f26ca5e6512.html
當(dāng)換取authorizer_refresh_token后建議保存。
接口調(diào)用請求說明
http請求方式: POST(請使用https協(xié)議) https:// api.weixin.qq.com /cgi-bin/component/api_authorizer_token?component_access_token=xxxxx
POST數(shù)據(jù)示例:
{ "component_appid":"appid_value", "authorizer_appid":"auth_appid_value", "authorizer_refresh_token":"refresh_token_value", }
請求參數(shù)說明
參數(shù) | 說明 |
---|---|
component_appid | 第三方平臺(tái)appid |
authorizer_appid | 授權(quán)方appid |
authorizer_refresh_token | 授權(quán)方的刷新令牌,刷新令牌主要用于第三方平臺(tái)獲取和刷新已授權(quán)用戶的access_token,只會(huì)在授權(quán)時(shí)刻提供,請妥善保存。一旦丟失,只能讓用戶重新授權(quán),才能再次拿到新的刷新令牌 |
返回結(jié)果示例
{ "authorizer_access_token": "aaUl5s6kAByLwgV0BhXNuIFFUqfrR8vTATsoSHukcIGqJgrc4KmMJ-JlKoC_-NKCLBvuU1cWPv4vDcLN8Z0pn5I45mpATruU0b51hzeT1f8", "expires_in": 7200, "authorizer_refresh_token": "BstnRqgTJBXb9N2aJq6L5hzfJwP406tpfahQeLNxX0w" }
結(jié)果參數(shù)說明
參數(shù) | 說明 |
---|---|
authorizer_access_token | 授權(quán)方令牌 |
expires_in | 有效期,為2小時(shí) |
authorizer_refresh_token | 刷新令牌 |
6、獲取授權(quán)方的帳號(hào)基本信息
該API用于獲取授權(quán)方的基本信息,包括頭像、昵稱、帳號(hào)類型、認(rèn)證類型、微信號(hào)、原始ID和二維碼圖片URL。
需要特別記錄授權(quán)方的帳號(hào)類型,在消息及事件推送時(shí),對于不具備客服接口的公眾號(hào),需要在5秒內(nèi)立即響應(yīng);而若有客服接口,則可以選擇暫時(shí)不響應(yīng),而選擇后續(xù)通過客服接口來發(fā)送消息觸達(dá)粉絲。
(1)公眾號(hào)獲取方法如下:
接口調(diào)用請求說明
http請求方式: POST(請使用https協(xié)議) https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_info?component_access_token=xxxx
POST數(shù)據(jù)示例:
{ "component_appid":"appid_value" , "authorizer_appid": "auth_appid_value" }
請求參數(shù)說明
參數(shù) | 說明 |
---|---|
component_appid | 第三方平臺(tái)appid |
authorizer_appid | 授權(quán)方appid |
返回結(jié)果示例
{ "authorizer_info": { "nick_name": "微信SDK Demo Special", "head_img": "http://wx.qlogo.cn/mmopen/GPy", "service_type_info": { "id": 2 }, "verify_type_info": { "id": 0 }, "user_name":"gh_eb5e3a772040", "principal_name":"騰訊計(jì)算機(jī)系統(tǒng)有限公司", "business_info": {"open_store": 0, "open_scan": 0, "open_pay": 0, "open_card": 0, "open_shake": 0}, "alias":"paytest01" "qrcode_url":"URL", }, "authorization_info": { "authorization_appid": "wxf8b4f85f3a794e77", "func_info": [ { "funcscope_category": { "id": 1 } }, { "funcscope_category": { "id": 2 } }, { "funcscope_category": { "id": 3 } } ] } }
結(jié)果參數(shù)說明
參數(shù) | 說明 |
---|---|
nick_name | 授權(quán)方昵稱 |
head_img | 授權(quán)方頭像 |
service_type_info | 授權(quán)方公眾號(hào)類型,0代表訂閱號(hào),1代表由歷史老帳號(hào)升級后的訂閱號(hào),2代表服務(wù)號(hào) |
verify_type_info | 授權(quán)方認(rèn)證類型,-1代表未認(rèn)證,0代表微信認(rèn)證,1代表新浪微博認(rèn)證,2代表騰訊微博認(rèn)證,3代表已資質(zhì)認(rèn)證通過但還未通過名稱認(rèn)證,4代表已資質(zhì)認(rèn)證通過、還未通過名稱認(rèn)證,但通過了新浪微博認(rèn)證,5代表已資質(zhì)認(rèn)證通過、還未通過名稱認(rèn)證,但通過了騰訊微博認(rèn)證 |
user_name | 授權(quán)方公眾號(hào)的原始ID |
principal_name | 公眾號(hào)的主體名稱 |
alias | 授權(quán)方公眾號(hào)所設(shè)置的微信號(hào),可能為空 |
business_info | 用以了解以下功能的開通狀況(0代表未開通,1代表已開通): open_store:是否開通微信門店功能 open_scan:是否開通微信掃商品功能 open_pay:是否開通微信支付功能 open_card:是否開通微信卡券功能 open_shake:是否開通微信搖一搖功能 |
qrcode_url | 二維碼圖片的URL,開發(fā)者最好自行也進(jìn)行保存 |
authorization_info | 授權(quán)信息 |
authorization_appid | 授權(quán)方appid |
func_info | 公眾號(hào)授權(quán)給開發(fā)者的權(quán)限集列表,ID為1到15時(shí)分別代表: 1.消息管理權(quán)限 2.用戶管理權(quán)限 3.帳號(hào)服務(wù)權(quán)限 4.網(wǎng)頁服務(wù)權(quán)限 5.微信小店權(quán)限 6.微信多客服權(quán)限 7.群發(fā)與通知權(quán)限 8.微信卡券權(quán)限 9.微信掃一掃權(quán)限 10.微信連WIFI權(quán)限 11.素材管理權(quán)限 12.微信搖周邊權(quán)限 13.微信門店權(quán)限 14.微信支付權(quán)限 15.自定義菜單權(quán)限 請注意: 1)該字段的返回不會(huì)考慮公眾號(hào)是否具備該權(quán)限集的權(quán)限(因?yàn)榭赡懿糠志邆洌埜鶕?jù)公眾號(hào)的帳號(hào)類型和認(rèn)證情況,來判斷公眾號(hào)的接口權(quán)限。 |
(2)小程序獲取方法如下
接口調(diào)用請求說明
http請求方式: POST(請使用https協(xié)議) https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_info?component_access_token=xxxx
POST數(shù)據(jù)示例:
{ "component_appid":"appid_value" , "authorizer_appid": "auth_appid_value" }
請求參數(shù)說明
參數(shù) | 說明 |
---|---|
component_appid | 第三方平臺(tái)appid |
authorizer_appid | 授權(quán)方appid |
返回結(jié)果示例:
{ "authorizer_info": { "nick_name": "微信SDK Demo Special", "head_img": "http://wx.qlogo.cn/mmopen/GPy", "service_type_info": { "id": 2 }, "verify_type_info": { "id": 0 }, "user_name":"gh_eb5e3a772040", "principal_name":"騰訊計(jì)算機(jī)系統(tǒng)有限公司", "business_info": {"open_store": 0, "open_scan": 0, "open_pay": 0, "open_card": 0, "open_shake": 0}, "qrcode_url":"URL", "signature": "時(shí)間的水緩緩流去", "MiniProgramInfo": { "network": { "RequestDomain":["https://www.qq.com","https://www.qq.com"], "WsRequestDomain":["wss://www.qq.com","wss://www.qq.com"], "UploadDomain":["https://www.qq.com","https://www.qq.com"], "DownloadDomain":["https://www.qq.com","https://www.qq.com"], }, "categories":[{"first":"資訊","second":"文娛"},{"first":"工具","second":"天氣"}], "visit_status": 0, } }, "authorization_info": { "authorization_appid": "wxf8b4f85f3a794e77", "func_info": [ { "funcscope_category": { "id": 17 } }, { "funcscope_category": { "id": 18 } }, { "funcscope_category": { "id": 19 } } ] } }
返回參數(shù)說明
參數(shù) | 說明 |
---|---|
nick_name | 授權(quán)方昵稱 |
head_img | 授權(quán)方頭像 |
service_type_info | 默認(rèn)為0 |
verify_type_info | 授權(quán)方認(rèn)證類型,-1代表未認(rèn)證,0代表微信認(rèn)證 |
user_name | 小程序的原始ID |
signature | 帳號(hào)介紹 |
principal_name | 小程序的主體名稱 |
business_info | 用以了解以下功能的開通狀況(0代表未開通,1代表已開通): open_store:是否開通微信門店功能 open_scan:是否開通微信掃商品功能 open_pay:是否開通微信支付功能 open_card:是否開通微信卡券功能 open_shake:是否開通微信搖一搖功能 |
qrcode_url | 二維碼圖片的URL,開發(fā)者最好自行也進(jìn)行保存 |
authorization_info | 授權(quán)信息 |
authorization_appid | 授權(quán)方appid |
miniprograminfo | 可根據(jù)這個(gè)字段判斷是否為小程序類型授權(quán) |
network | 小程序已設(shè)置的各個(gè)服務(wù)器域名 |
func_info | 小程序授權(quán)給開發(fā)者的權(quán)限集列表,ID為17到19時(shí)分別代表: 17.帳號(hào)管理權(quán)限 18.開發(fā)管理權(quán)限 19.客服消息管理權(quán)限 請注意: 1)該字段的返回不會(huì)考慮小程序是否具備該權(quán)限集的權(quán)限(因?yàn)榭赡懿糠志邆洌?/td> |
7、獲取授權(quán)方的選項(xiàng)設(shè)置信息
該API用于獲取授權(quán)方的公眾號(hào)或小程序的選項(xiàng)設(shè)置信息,如:地理位置上報(bào),語音識(shí)別開關(guān),多客服開關(guān)。注意,獲取各項(xiàng)選項(xiàng)設(shè)置信息,需要有授權(quán)方的授權(quán),詳見權(quán)限集說明。
接口調(diào)用請求說明
http請求方式: POST(請使用https協(xié)議) https://api.weixin.qq.com/cgi-bin/component/ api_get_authorizer_option?component_access_token=xxxx
POST數(shù)據(jù)示例
{ "component_appid":"appid_value", "authorizer_appid": " auth_appid_value ", "option_name": "option_name_value" }
請求參數(shù)說明
參數(shù) | 說明 |
---|---|
component_appid | 第三方平臺(tái)appid |
authorizer_appid | 授權(quán)公眾號(hào)或小程序的appid |
option_name | 選項(xiàng)名稱 |
返回結(jié)果示例
{ "authorizer_appid":"wx7bc5ba58cabd00f4", "option_name":"voice_recognize", "option_value":"1" }
結(jié)果參數(shù)說明
參數(shù) | 說明 |
---|---|
authorizer_appid | 授權(quán)公眾號(hào)或小程序的appid |
option_name | 選項(xiàng)名稱 |
option_value | 選項(xiàng)值 |
8、設(shè)置授權(quán)方的選項(xiàng)信息
該API用于設(shè)置授權(quán)方的公眾號(hào)或小程序的選項(xiàng)信息,如:地理位置上報(bào),語音識(shí)別開關(guān),多客服開關(guān)。注意,設(shè)置各項(xiàng)選項(xiàng)設(shè)置信息,需要有授權(quán)方的授權(quán),詳見權(quán)限集說明。
接口調(diào)用請求說明
http請求方式: POST(請使用https協(xié)議) https://api.weixin.qq.com/cgi-bin/component/ api_set_authorizer_option?component_access_token=xxxx
POST數(shù)據(jù)示例
{ "component_appid":"appid_value", "authorizer_appid": " auth_appid_value ", "option_name": "option_name_value", "option_value":"option_value_value" }
請求參數(shù)說明
參數(shù) | 說明 |
---|---|
component_appid | 第三方平臺(tái)appid |
authorizer_appid | 授權(quán)公眾號(hào)或小程序的appid |
option_name | 選項(xiàng)名稱 |
option_value | 設(shè)置的選項(xiàng)值 |
返回結(jié)果示例
{ "errcode":0, "errmsg":"ok" }
結(jié)果參數(shù)說明
參數(shù) | 說明 |
---|---|
errcode | 錯(cuò)誤碼 |
errmsg | 錯(cuò)誤信息 |
選項(xiàng)名和選項(xiàng)值表
option_name | option_value | 選項(xiàng)值說明 |
---|---|---|
location_report(地理位置上報(bào)選項(xiàng)) | 0 | 無上報(bào) |
1 | 進(jìn)入會(huì)話時(shí)上報(bào) | |
2 | 每5s上報(bào) | |
voice_recognize(語音識(shí)別開關(guān)選項(xiàng)) | 0 | 關(guān)閉語音識(shí)別 |
1 | 開啟語音識(shí)別 | |
customer_service(多客服開關(guān)選項(xiàng)) | 0 | 關(guān)閉多客服 |
1 | 開啟多客服 |
9、推送授權(quán)相關(guān)通知
當(dāng)公眾號(hào)對第三方平臺(tái)進(jìn)行授權(quán)、取消授權(quán)、更新授權(quán)后,微信服務(wù)器會(huì)向第三方平臺(tái)方的授權(quán)事件接收URL(創(chuàng)建第三方平臺(tái)時(shí)填寫)推送相關(guān)通知。
POST數(shù)據(jù)示例(授權(quán)成功通知)
<xml> <AppId>第三方平臺(tái)appid</AppId> <CreateTime>1413192760</CreateTime> <InfoType>authorized</InfoType> <AuthorizerAppid>公眾號(hào)appid</AuthorizerAppid> <AuthorizationCode>授權(quán)碼(code)</AuthorizationCode> <AuthorizationCodeExpiredTime>過期時(shí)間</AuthorizationCodeExpiredTime> <PreAuthCode>預(yù)授權(quán)碼</PreAuthCode> <xml>
POST數(shù)據(jù)示例(取消授權(quán)通知)
<xml> <AppId>第三方平臺(tái)appid</AppId> <CreateTime>1413192760</CreateTime> <InfoType>unauthorized</InfoType> <AuthorizerAppid>公眾號(hào)appid</AuthorizerAppid> </xml>
POST數(shù)據(jù)示例(授權(quán)更新通知)
<xml> <AppId>第三方平臺(tái)appid</AppId> <CreateTime>1413192760</CreateTime> <InfoType>updateauthorized</InfoType> <AuthorizerAppid>公眾號(hào)appid</AuthorizerAppid> <AuthorizationCode>授權(quán)碼(code)</AuthorizationCode> <AuthorizationCodeExpiredTime>過期時(shí)間</AuthorizationCodeExpiredTime> <PreAuthCode>預(yù)授權(quán)碼</PreAuthCode> <xml>
第三方平臺(tái)方在收到授權(quán)相關(guān)通知后也需進(jìn)行解密(詳細(xì)請見【消息加解密接入指引】),接收到后之后只需直接返回字符串success。為了加強(qiáng)安全性,postdata中的xml將使用服務(wù)申請時(shí)的加解密key來進(jìn)行加密,具體請見【公眾號(hào)第三方平臺(tái)的加密解密技術(shù)方案】
字段說明:
字段名稱 | 字段描述 |
---|---|
AppId | 第三方平臺(tái)appid |
CreateTime | 時(shí)間戳 |
InfoType | unauthorized是取消授權(quán),updateauthorized是更新授權(quán),authorized是授權(quán)成功通知 |
AuthorizerAppid | 公眾號(hào)或小程序 |
AuthorizationCode | 授權(quán)碼,可用于換取公眾號(hào)的接口調(diào)用憑據(jù),詳細(xì)見上面的說明 |
AuthorizationCodeExpiredTime | 授權(quán)碼過期時(shí)間 |
PreAuthCode |
預(yù)授權(quán)碼 |
【2018微信小程序最新API接口與插件大全】資料來源于微信公眾號(hào)官方網(wǎng)站,如需了解最新API接口和插件,請及時(shí)登錄微信公眾號(hào)官網(wǎng)查看。
掃二維碼手機(jī)查看該文章