getUserProfile
獲取當前用戶信息
H5 可以通過此接口獲取運行宿主設備的關鍵信息穗泵，比如屏幕信息，平臺信息等期吓。
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| 無 |
未登錄 - 返回結果
無
已登錄 - 返回結果
{
no: "88888888", // 用戶編號
nick_name: "法外狂徒丶張三", // 用戶昵稱
token: "tokenxxxxx", // 用戶授權 Token
thumb_url: "http://x.xxx.cn/xxx.png", // 用戶頭像地址
im_id: "xxxx", // 網(wǎng)易云信 ID
im_token: "xxxx", // 網(wǎng)易云信 Token
mobile: "13673552648", // 用戶登錄手機號
money: "0.00", // 用戶賬戶余額
}
getDeviceInfo
獲取設備信息
H5 可以通過此接口獲取運行宿主設備的關鍵信息敲茄，比如屏幕信息娃善，平臺信息等。
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| 無 |
返回結果
{
platform: "iOS", // 平臺名稱奶是，允許值：Android楣责，iOS，Mini聂沙，Web
versionCode: 1, // App 版本號
versionName: "1.0.0", // App 版本名稱
device: {
uniqueId: "xxxxx", // 當前設備唯一的標識
},
screen: {
statusBarHeight: 20, // 電池條/狀態(tài)欄的高度
titleBarHeight: 44, // 標題條的高度
screenWidth: 0, // 手機屏幕的寬度
screenHeight: 0, // 手機屏幕的高度
PPI： 160 // 手機設備像素密度
}
}
finishActivity
銷毀當前活動頁面
H5 可以直接調(diào)用此 API 銷毀當前所在頁面秆麸，客戶端 APP 請在頁面被銷毀之后及時回收系統(tǒng)資源。
接口參數(shù)
無
返回結果
無
nativeActivity
打開指定本機 App 頁面
H5 頁面在宿主機運行時及汉，可能也會根據(jù)功能流程跳轉至原生 APP 界面沮趣，或者想要求本機 APP 在新的活動頁面中打開指定鏈接地址，來保護瀏覽器歷史路徑的干凈坷随。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| mode | String | 是 | 啟動模式：finish房铭，self，keeplive |
| uri | String | 是 | 要跳轉的頁面 URI 地址路徑 |
| meta | Object/Null | 否 | 部分頁面在跳轉時温眉，可能要求攜帶參數(shù)缸匪，此字段為這些頁面提供所需要的數(shù)據(jù) |
| full | Boolean | 是 | 聲明是否全屏（沉浸式）加載指定 H5 頁面，此字段僅在 http 頁面跳轉時有效类溢，并且 self 模式跳轉也請忽略此字段 |
關于啟動模式 mode 字段的功能實現(xiàn)凌蔬，詳細說明如下：
- finish： 表明客戶端在跳轉至新的頁面時，請直接把當前頁面銷毀豌骏。
- self： 要求客戶端在當前瀏覽器頁面打開指定鏈接
- blank： 要求客戶端在新的瀏覽器頁面打開指定鏈接
關于 meta 字段的屬性龟梦，會根據(jù)所跳轉的界面而不同，具體參數(shù)請查看 頁面跳轉 文檔窃躲。
返回結果
無
getLocalValue
獲取本機存儲數(shù)據(jù)
H5 調(diào)用此接口可以取得使用 putLocalValue 存入的本地數(shù)據(jù)计贰，客戶端必須保證數(shù)據(jù)與存入時完全保持一致。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| key | String | 是 | 存入數(shù)據(jù)時蒂窒，設置的鍵 Key |
| default | String | 否 | 指定鍵 Key 不存在時的默認返回值 |
返回結果
任意存入值
putLocalValue
存儲數(shù)據(jù)到本機
H5 調(diào)用此接口可以把任意數(shù)據(jù)永久存放到本機空間躁倒，客戶端可以對數(shù)據(jù)使用任意的格式存儲，但必須保證數(shù)據(jù)不會丟失洒琢，且取出時與存入時數(shù)據(jù)一致秧秉。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| key | String | 是 | 存入數(shù)據(jù)時，設置的鍵 Key |
| value | String | 是 | 要存入的數(shù)據(jù)衰抑，只能為字符串類型 |
返回結果
true | false
rmLocalValue
移除存儲到本機的數(shù)據(jù)
H5 調(diào)用 putLocalValue 存儲的數(shù)據(jù)象迎，可以調(diào)用此函數(shù)進行清理。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| key | String | 是 | 存入數(shù)據(jù)時，設置的鍵 Key |
返回結果
true | false
selectUserAddress
選擇用戶收貨地址
用戶在購買商品時砾淌，需要選擇收貨地址啦撮，現(xiàn)在收貨地址功能是原生APP客戶端實現(xiàn)的，需要客戶端引導用戶選擇收貨地址汪厨，并返回收貨地址信息赃春。
接口參數(shù)
無
返回結果
{
"id": 2, // 收貨地址id
"name": "建委", // 收貨人姓名
"mobile": "15639010691", //收貨人手機號
"province_code": "410000000000", //省份行政代碼
"province_name": "河南省", //省份名稱
"province_short": "河南", //省份簡稱
"city_code": "410100000000", //市份行政代碼
"city_name": "鄭州市", //市份名稱
"city_short": "鄭州", //市份簡稱
"county_code": "410105000000", //區(qū)份行政代碼
"county_name": "金水區(qū)", //區(qū)份名稱
"county_short": "金水", //區(qū)份簡稱
"address": "asdffffffffffffffffff", //詳細地址
"is_default": 0 //是否默認，1=默認劫乱，0=非默認
}
appPay
喚起 App 客戶端的第三方支付功能
H5 可以使用此接口進行所有場景的支付功能調(diào)用织中，客戶端只需要把用戶支付成功的返回結果 notify 給 H5 頁面即可。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| channel | String | 是 | 要調(diào)用的支付渠道 |
| signData | String 或 Object | 是 | H5 已經(jīng)準備好的支付簽名數(shù)據(jù)衷戈，此字段會根據(jù)要調(diào)用支付渠道的不同而不同 |
- channel =
alipay代表是支付寶支付
signData = 'body=Hello&buyer_email=13788888888&buyer_id=2088002007013600&extra_common_param=你好狭吼，這是測試商戶的廣告。&gmt_create=2014-04-03 20:49:31&gmt_payment=2014-04-03 20:49:50&is_total_fee_adjust=N¬ify_id=70fec0c2730b27528665af4517c27b95¬ify_time=2014-04-03 20:49:52¬ify_type=trade_status_sync&out_trade_no=3618810634349901&price=10.00&quantity=1&seller_email=test@test.com&seller_id=2088002007018916&subject=測試&total_fee=10.00&trade_no=2014040311001004370000361525&trade_status=TRADE_FINISHED&use_coupon=N'
- channel =
wechat代表是微信支付
signData = {
appid: 'wx8888888888888888',
partnerid: '1900000109',
prepayid: 'WX1217752501201407033233368018',
package: 'Sign=WXPay',
noncestr: '5K8264ILTKCH16CQ2502SI8ZNMTM67VS',
timestamp: '1412000000',
sign: 'C380BEC2BFD727A4B6845133519F3AD6'
}
返回結果
{
status: 'success | error', // 成功返回 success 字符串脱惰，失敗返回 error 字符串
message: '這里是支付錯誤的時候搏嗡，返回的提示信息'
}
scanQRCode
調(diào)用掃描二維碼功能
在部分頁面場景可能需要 H5 使用掃描二維碼功能，可以調(diào)用此功能接口來獲取二維碼的掃描結果拉一。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| type | String | 是 | 要掃描的碼類型 |
- type =
qr-code代表要掃描的二維碼類型 - type =
bar-code代表要掃描的是條形碼類型
返回結果
直接返回掃碼數(shù)據(jù)
oauth2
喚起第三方應用授權
用戶綁定支付寶和綁定微信賬號時采盒，可以使用 OAuth2 協(xié)議喚起第三方應用進行用戶授權，以便 H5 獲取授權后的信息蔚润。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| app | String | 是 | 要進行 OAuth2 授權的 APP 名稱 |
-
alipay= 支付寶授權 -
wechat= 微信授權
返回原始授權數(shù)據(jù)
{
key: value,
...
}
mustLoginDlg
顯示用戶還未登錄磅氨，提醒登錄的彈窗
H5 頁面上彈出的彈窗，在個別界是無法使用的嫡纠，需要客戶端提供此彈窗接口限制用戶操作烦租。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| message | String | 是 | 提醒文案 |
| title | String | 是 | 彈窗標題 |
返回結果
true | false
- true = 用戶去登錄了，與登錄結果無關
- false = 用戶沒有去登錄除盏，與登錄結果無關
selectPicture
讓用戶選擇一張圖片
H5 使用選擇圖片功能在安卓上有兼容性問題叉橱，所以實現(xiàn)此 API 用來讓 H5 調(diào)用原生的圖片選擇。
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| min | Integer | 是 | 指定圖片壓縮到此閾值以內(nèi)者蠕，單位：kb窃祝，對所有場景有效 |
| scene | string | 是 | 用戶選擇圖片的場景，客戶端來根據(jù)場景顯示定制頁面 |
| meta | Object | 否 | 在不同場景中選擇圖片時踱侣，此字段從來給場景傳遞的額外的參數(shù) |
scene = default
默認使用的圖片選擇場景粪小，單選，不裁剪抡句，直接返回探膊。scene = homepage
個人主頁使用的圖片上傳場景，多選（≤9張）待榔，不裁剪，直接上傳至阿里云服務器，并返回阿里云鏈接猾担。
{
max: 9 // 代表最多允許上傳9張圖片
}
popFindAlter
發(fā)現(xiàn)界面調(diào)用原生彈窗
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| btns | Array | 是 | 彈窗的列表展示信息 |
Params 參數(shù)樣例數(shù)據(jù)
{
"btns": [
{"title": "收藏", "id": "1"},
{"title": "舉報", "id": "2"},
]
}
返回結果
Base64 編碼的 JSON 對象
{
"id":1234 //// 以上操作的相應條目的id
}
goToThreeApp
點擊第三方app按鈕的事件
接口參數(shù)
| 參數(shù) | 類型 | 必須 | 說明 |
|---|---|---|---|
| appId | String | 是 | 點擊的第三方app的id |
參數(shù)說明
1是微博袭灯；2是知乎刺下；3是抖音绑嘹；4是快手；5是微視橘茉；6是嗶哩嗶哩
返回結果
nil
