小程序服务器api接口,百度智能小程序API 开放接口

本文涉及的产品
密钥管理服务KMS,1000个密钥,100个凭据,1个月
简介: 小程序服务器api接口,百度智能小程序API 开放接口

登录

智能小程序可以通过百度官方提供的登录能力方便地获取百度提供的用户身份标识,快速建立智能小程序内的用户体系。

流程说明

1、调用 swan.login() 获取 临时登录凭证code ,并回传到开发者服务器。

2、开发者服务器以 code 换取 session_key。

3、调用 swan.getUserInfo() 获取用户信息。

4、点击查看详细流程。

login

解释: 调用接口 swan.login 获取 临时登录凭证(code)

参数: Object

Object参数说明:

参数名

类型

必填

说明

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明:

参数

类型

说明

code

String

用户登录凭证(有效期五分钟)。开发者需要在开发者服务器后台调用 api,使用 code 换取 session_key 等信息

示例:swan.login({undefined

success: function (res) {undefined

swan.request({undefined

url: 'https://xxx/xxx', // 开发者服务器地址

data: {undefined

code: res.code

}

});

},

fail: function (err) {undefined

console.log('login fail', err);

}

});

登录凭证校验

临时登录凭证校验接口是一个 HTTPS 接口,开发者服务器使用 临时登录凭证(code) 获取 session_key。

注意:

1、会话密钥 session_key 是对用户数据进行加密签名的密钥。为了应用自身的数据安全,开发者服务器不应该把会话密钥下发到智能小程序,也不应该对外提供这个密钥。

2、临时登录凭证 code 只能使用一次。

接口地址:https://openapi.baidu.com/nalogin/getSessionKeyByCode

请求参数

参数

说明

client_id

开放平台申请的 App Key

sk

开放平台申请的 App Secret

code

swan.login 返回的临时登录凭证

Bug & Tip

1、tip: 调用 login 会引起登录态的刷新,之前的 session_key 可能会失效。

checkSession

解释:通过上述接口获得的用户登录态拥有一定的时效性,用户越久未使用智能小程序,用户登录态越有可能失效;反之如果用户一直在使用智能小程序,则用户登录态一直保持有效。具体时效逻辑由百度 App 维护,对开发者透明。开发者可以调用 swan.checkSession 接口 检测当前用户登录态是否有效,登录态过期后开发者可以再调用 swan.login 获取新的用户登录态。

参数:Object

Object参数说明:

参数名

类型

必填

说明

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

示例:

swan.checkSession({undefined

success: function (res) {undefined

console.log('登录态有效');

},

fail: function (err) {undefined

console.log('登录态无效');

}

});

用户数据的签名验证和加解密

智能小程序可以通过各种前端接口获取百度提供的开放数据。考虑到开发者服务器也需要获取这些开放数据,百度会对这些数据做签名和加密处理。开发者后台拿到开放数据后可以对数据进行校验签名和解密,来保证数据不被篡改。

加密数据解密算法

接口如果涉及敏感数据,接口的明文内容将不包含这些敏感数据。开发者如需要获取敏感数据,需要对接口返回的加密数据(data)进行对称解密。

解密过程:开发者智能小程序(通过 swan.request)将加密数据发送至自身 Server 进行解密后返回智能小程序。

解密算法如下:

1、对称解密使用的算法为 AES-128-CBC,数据采用PKCS#7填充。

2、对称解密的目标密文为 Base64_Decode(data)。

3、对称解密秘钥 AESKey = Base64_Decode(session_key), AESKey 是24字节。

4、对称解密算法初始向量 为Base64_Decode(iv),其中iv由数据接口返回。

授权

authorize

解释:提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权智能小程序使用某项功能或获取用户的某些数据,但不会实际调用对应接口。如果用户之前已经同意授权,则不会出现弹窗,直接返回成功。

参数:Object

Object参数说明:

参数名

类型

必填

说明

scope

String

需要获取权限的 scope,详见 scope 列表

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

scope 列表

scope

对应接口

描述

scope.userInfo

swan.getUserInfo

用户信息

scope.userLocation

swan.getLocation, swan.chooseLocation

地理位置

scope.writePhotosAlbum

swan.saveImageToPhotosAlbum

保存到相册

scope.address

swan.chooseAddress

收获地址

scope.invoiceTitle

swan.chooseInvoiceTitle

发票抬头

scope.record

swan.getRecorderManager

录音功能

scope.camera

摄像头

success返回参数说明:

参数名

类型

说明

errMsg

String

调用结果

示例:

swan.authorize({undefined

scope: 'scope.userLocation',

success: function (res) {undefined

// 用户已经同意智能小程序使用定位功能

swan.getLocation();

}

});

Bug & Tip

1、tip: 授权操作为异步操作,完成前请不要多次调用。

用户信息

swanid 机制说明

swanid 是用户使用智能小程序时的标识符,开发者可以通过 swanid 来区分用户的唯一性。

1、用户在非登陆情况下使用智能小程序时,在同一台设备上使用同一个开发者所开发的不同智能小程序,得到的是相同的 swanid。2、用户在登陆情况下使用智能小程序时,在多台不同设备上使用同一个开发者所开发的不同智能小程序,得到的是相同的 swanid。3、用户使用同一台设备时,在非登陆情况下与登陆情况下使用同一个智能小程序,得到的 swanid 是不同的。

getSwanId

解释:获取 swanid。

参数:Object

Object参数说明:

参数名

类型

必填

说明

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数

类型

说明

errno

String

errno

data

Object

{swanid}

errmsg

String

errmsg

示例:swan.getSwanId({undefined

success: function (res) {undefined

console.log(res.data.swanid);

}

});

getUserInfo

解释:获取用户信息

参数:Object

Object参数说明:

参数名

类型

必填

说明

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数

类型

说明

userInfo

Object

用户信息对象

data

String

包括敏感数据在内的完整用户信息的加密数据,加解密逻辑参考用户数据的签名验证和加解密

iv

String

加密算法的初始向量

userInfo参数说明:

参数

类型

说明

nickName

String

用户名

avatarUrl

String

用户头像

gender

String

性别

示例:

swan.getUserInfo({undefined

success: function (res) {undefined

console.log('用户名', res.nickName);

}

});

设置

openSetting

解释:调起客户端智能小程序设置界面,返回用户设置的操作结果。

参数:Object

Object参数说明:

参数名

类型

必填

说明

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数

类型

说明

authSetting

Object

用户授权结果,其中 key 为 scope 值,value 为 Bool 值,表示用户是否允许授权

示例:

swan.openSetting({undefined

success: function (res) {undefined

console.log(res.authSetting['scope.userInfo']);

console.log(res.authSetting['scope.userLocation']);

}

});

getSetting

解释:获取用户的当前设置

参数:Object

Object参数说明:

参数名

类型

必填

说明

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数

类型

说明

authSetting

Object

用户授权结果,其中 key 为 scope 值,value 为 Bool 值,表示用户是否允许授权

示例:

swan.getSetting({undefined

success: function (res) {undefined

console.log(res.authSetting['scope.userInfo']);

console.log(res.authSetting['scope.userLocation']);

}

});

分享

onShareAppMessage

解释:在 Page 中定义 onShareAppMessage 函数,设置该页面的分享信息。

用户点击分享按钮的时候会调用

此事件需要 return 一个Object,用于自定义分享内容

参数:Object

Object参数说明:

参数名

类型

说明

from

String

分享事件来源。button:页面内转发按钮;menu:右上角分享菜单

currentTarget

Object

如果 from 值是 button,则 currentTarget 是触发这次转发事件的 button,否则为 undefined

自定义分享字段:

参数名

类型

必填

说明

title

String

分享标题

content

String

分享内容

imageUrl

String

分享图标

path

String

页面 path ,必须是以 / 开头的完整路径

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

示例:Page({undefined

onShareAppMessage() {undefined

return {undefined

title: '智能小程序示例',

content: '世界很复杂,百度更懂你',

path: '/pages/openShare/openShare?key=value'

};

}

});

Bug & Tip

1、bug: iOS 点击分享面板的取消时,会执行 fail,Android 不会执行。

收获地址

chooseAddress

解释:调起用户编辑收货地址原生界面,并在编辑完成后返回用户选择的地址。

需要用户授权 scope.address

参数:Object

Object参数说明:

参数名

类型

必填

说明

success

Function

返回用户选择的收货地址信息

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数名

类型

说明

errMsg

String

调用结果

userName

String

收货人姓名

postalCode

String

邮编

provinceName

String

国标收货地址第一级地址

cityName

String

国标收货地址第二级地址

countyName

String

国标收货地址第三级地址

detailInfo

String

详细收货地址信息

telNumber

String

收货人手机号码

示例:

swan.chooseAddress({undefined

success: function (res) {undefined

console.log(res.userName);

console.log(res.postalCode);

console.log(res.provinceName);

console.log(res.cityName);

console.log(res.countyName);

console.log(res.detailInfo);

console.log(res.telNumber);

}

});

聚合收银台支付

requestPolymerPayment

版本:百度 App 10.7.0 版本开始支持。

解释:百度聚合收银台,聚合了主流的百度钱包、微信、支付宝、网银等多种支付方式,方便开发者一站式快速接入多种支付渠道,让百度用户能在智能小程序场景下,直接完成支付、交易闭环,提升用户支付体验的同时,提高智能小程序的订单转化率。

参数:Object

Object参数说明:

参数名

类型

必填

说明

orderInfo

Object

订单信息

bannedChannels

StringArray

需要隐藏的支付方式

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

orderInfo 参数说明:

dealId: 跳转百度收银台支付必带参数之一,是百度收银台的财务结算凭证,与账号绑定的结算协议一一对应,每笔交易将结算到dealId对应的协议主体。

appKey: 用以表示应用身份的唯一ID,在应用审核通过后进行分配,一经分配后不会发生更改,来唯一确定一个应用。

totalAmount: 订单金额,单位为人民币分。

tpOrderId: 商户平台自己记录的订单ID,当支付状态发生变化时,会通过此订单ID通知商户。

dealTitle: 订单的名称。

rsaSign: 对appKey+dealId+tpOrderId进行RSA加密后的密文,防止订单被伪造。签名过程见 百度电商开放平台:签名与验签

bizInfo: 订单详细信息,需要是一个可解析为JSON Object的字符串。字段内容见: 百度电商开放平台:收银台接入

bannedChannels 参数说明:

channel

说明

Alipay

支付宝

BDWallet

百度钱包

WeChat

微信支付

示例:swan.requestPolymerPayment({undefined

orderInfo: {undefined

"dealId": "470193086",

"appKey": "MMMabc",

"totalAmount": "1",

"tpOrderId": "3028903626",

"dealTitle": "智能小程序Demo支付测试",

"rsaSign": '',

"bizInfo": ''

},

success: function (res) {undefined

swan.showToast({undefined

title: '支付成功',

icon: 'success'

});

},

fail: function (err) {undefined

swan.showToast({undefined

title: JSON.stringify(err)

});

console.log('pay fail', err);

}

});

获取发票抬头

chooseInvoiceTitle

解释:选择用户的发票抬头。

需要用户授权 scope.invoiceTitle

参数:Object

Object参数说明:

参数名

类型

必填

说明

success

Function

接口调用成功的回调函数

fail

Function

接口调用失败的回调函数

complete

Function

接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数名

类型

说明

type

String

抬头类型(0:单位,1:个人)

title

String

抬头名称

taxNumber

String

抬头税号

companyAddress

String

单位地址

telephone

String

手机号码

bankName

String

银行名称

bankAccount

String

银行账号

errMsg

String

接口调用结果

示例:swan.chooseInvoiceTitle({undefined

success: function (res) {undefined

console.log(res.type);

console.log(res.title);

console.log(res.taxNumber);

console.log(res.companyAddress);

console.log(res.telephone);

console.log(res.bankName);

console.log(res.bankAccount);

}

})

目录
相关文章
|
2天前
|
移动开发 开发框架 小程序
轻松搭建婚恋交友系统源码,H5/小程序/APP自动适配,智能匹配恋爱交友平台快速落地
婚恋交友系统涵盖在线交友、线下活动、专业服务、社交娱乐等,满足用户多样化需求。系统设计简洁易用,提供实名认证、多注册方式及安全保护,确保用户隐私和数据安全。功能丰富,支持图文展示、筛选匹配、聊天互动、虚拟礼物等,提升互动趣味性。平台可分类管理用户、审核信息、智能推荐,优化用户体验。基于TP6+Uni-app框架,实现跨平台同步,支持二次开发,适应不同市场需求。 [了解更多](https://gitee.com/multi-customer-software/jy)
25 6
|
9天前
|
监控 数据挖掘 API
京东商品历史价格 API 接口系列(京东 API)
本文介绍了如何使用京东开放平台API获取商品价格信息。首先,需注册账号并创建应用以获取App Key和App Secret,进而获取Access Token。准备好开发工具后,通过调用`jd.item_search`和`jd.item_get`接口,可以分别按关键字搜索商品和获取指定商品的详细信息及价格。示例代码展示了如何使用Python的requests库进行API请求。应用场景包括价格监控、商家定价策略、电商平台数据分析及商业智能决策支持。
58 10
|
11天前
|
缓存 API 开发者
京东按图搜索商品(拍立淘)API接口系列(京东API)
京东按图搜索商品(拍立淘)API 接口(.jd.item_search_img)通过上传图片搜索京东平台上的相似商品,基于图像识别技术提供便捷的商品搜索方式。适用于电商平台展示、比价等场景。响应参数包括公共参数、商品信息及搜索结果相关参数,方便分页展示和了解整体搜索规模。Python 请求示例展示了如何使用该接口进行图片搜索。
61 15
|
4天前
|
JSON 数据挖掘 API
京东商品视频 API 接口系列(京东 API)
京东商品视频API用于获取商品视频的URL、时长、分辨率等信息,适用于电商平台开发、数据分析、商品推荐优化及竞品分析。需安装`requests`库并使用Python内置`json`库解析数据。请求时需提供`productId`等参数,返回JSON格式数据。示例代码展示了如何通过签名验证和参数构建进行API调用。
|
11天前
|
JSON 监控 API
京东商品列表 API 接口系列(京东 API)
京东商品列表API接口为开发者提供获取店铺内商品详细信息的功能,包括名称、价格、库存、图片、ID、销量等。通过HTTP GET请求并包含必要参数(如店铺ID、API密钥),可获取JSON格式的商品列表数据,适用于展示、库存管理、价格监控等场景。示例代码展示了使用Python调用该接口的方法,返回的数据包含状态码、商品总数、分页信息及具体商品详情。
|
5天前
|
JSON 数据挖掘 API
京东app商品详情API接口系列(京东 API)
本文介绍了使用 Python 调用京东商品详情 API 的方法。前期需安装 `requests` 库处理 HTTP 请求,导入 `json` 库解析 JSON 数据。接口通过商品 ID 获取详细信息,如价格、图片、评价等。示例代码展示了如何构建请求并处理响应数据。应用场景包括电商开发、市场调研和数据分析等,帮助提升用户体验、优化推荐系统及制定市场策略。
|
9天前
|
JSON 数据挖掘 API
京东店铺所有商品 API 接口系列(京东 API)
京东店铺所有商品API接口用于获取指定店铺的全面商品信息,包括基本属性、价格、库存、销售数据等。前期需仔细研读接口文档,掌握请求地址、参数格式及频率限制。接口支持分页和筛选参数,返回JSON格式数据。Python示例中使用`requests`库发送HTTP请求并处理返回数据。该API适用于竞品分析、商品管理工具开发、市场调研及价格监测等场景,助力电商从业者优化运营策略。
|
3天前
|
JSON 监控 API
京东商品列表 API 接口系列(京东 API)
本简介介绍了使用 Python 调用京东商品搜索和详情 API 的方法。首先需安装 `requests` 库,`hashlib` 和 `time` 为内置库无需安装。API 支持按关键词、类别等条件搜索商品,返回 JSON 格式的商品列表,包括 ID、名称、价格等信息。通过商品 ID 可获取详细信息如描述、规格等。示例代码展示了如何生成签名并发送请求。应用场景包括市场调研、竞品监测和价格预警等,为企业决策提供数据支持。
|
2月前
|
负载均衡 数据可视化 API
像素流送api ue多人访问需要什么显卡服务器
本文总结了关于像素流送技术的五大常见问题,包括是否支持Unity模型推流、UE多人访问的最大并发数、所需服务器配置、稳定性问题及API支持情况,旨在帮助开发者更好地理解和应用这一技术。
73 1
|
2月前
|
新能源 API
百科-百度免费API接口教程
该接口用于从百度百科获取指定名词的基础解释。支持POST或GET请求,需提供用户ID、用户KEY及查询内容。返回状态码和解释内容或错误提示。示例:https://cn.apihz.cn/api/zici/baikebaidu.php?id=88888888&key=88888888&words=汽车。建议使用个人ID与KEY以享受更高调用频次。