SDK 引入
npm install alipay-dev --save
import alipaydev from 'alipay-dev'// 或者const alipaydev = require('alipay-dev')
初始化配置
alipaydev.setConfig({
toolId: '',
privateKey: '',
})
小程序預(yù)覽
示例代碼
const previewResult = await alipaydev.miniPreview({
project: '/code/mini/path',
appId: '2019012963164448',
page: 'page/shop/detail?id=10&from=name'})
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
project |
是 |
本地項(xiàng)目地址 |
無 |
appId |
是 |
小程序appId |
無 |
page |
否 |
落地頁(yè) |
無 |
launch |
否 |
app.js 的 onLaunch 中取得 |
無 |
qrcodeFormat |
否 |
返回二維碼文件的格式。 terminal、base64、image |
image |
qrcodeOutput |
否 |
二維碼文件保存路徑 |
無 |
返回
屬性 |
類型 |
說明 |
schema |
string |
支付寶 schema 鏈接 |
qrcode |
string |
schema 對(duì)應(yīng)的二維碼 |
小程序上傳
示例代碼
const uploadResult = await alipaydev.miniUpload({
project: '/code/mini/path',
appId: '2019012963164448',
clientType: 'alipay',
experience: true,
onProgressUpdate (info) {
const { status, data } = info console.log(status, data)
}
})
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
project |
是 |
項(xiàng)目目錄 |
無 |
appId |
是 |
小程序 appId |
無 |
packageVersion |
否 |
上傳包版本 |
線上包版本自增 0.0.1 |
clientType |
否 |
上傳的終端。 支付寶:alipay,高德:amap |
alipay |
experience |
否 |
上傳成功后,自動(dòng)設(shè)置為體驗(yàn)版本, 該功能只針對(duì)小程序主賬號(hào)生效 |
false |
onProgressUpdate |
否 |
上傳過程中的回調(diào) |
無 |
返回
屬性 |
類型 |
說明 |
packages |
package[] |
編譯后的代碼包信息 |
- package.name |
string |
上傳包名字 |
- package.type |
string |
類型,整包,主包,分包 |
- package.size |
string |
上傳包尺寸,單位 KB |
packageVersion |
string |
上傳包的版本 |
qrCodeUrl |
string |
體驗(yàn)二維碼在線地址 |
空間列表
示例代碼
const result = await alipaydev.cloudSpaceList('2021001158675201')
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
appId |
是 |
小程序 appId |
無 |
返回
返回一個(gè)數(shù)組,每一項(xiàng)屬性如下
屬性 |
類型 |
說明 |
appWorkspaceId |
string |
空間 ID |
name |
string |
空間名稱 |
envStatus |
string |
空間狀態(tài) |
指定空間下的云函數(shù)列表
示例代碼
const result = await alipaydev.cloudFunctionList({
appId: '2021001158675201',
spaceId: '02664190-6841-4f50-980a-12121504a807'})
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
appId |
是 |
小程序 appId |
無 |
spaceId |
是 |
服務(wù)空間 ID |
無 |
返回
返回一個(gè)數(shù)組,每一項(xiàng)屬性如下
屬性 |
類型 |
說明 |
name |
string |
云函數(shù)名稱 |
desc |
string |
云函數(shù)描述 |
createdAt |
string |
創(chuàng)建時(shí)間 |
modifiedAt |
string |
修改時(shí)間 |
timeout |
string |
云函數(shù)超時(shí)時(shí)間 |
運(yùn)行本地云函數(shù)
示例代碼
const result = await alipaydev.invokeLocalFunction({
appId: '20190666750666',
spaceId: '1d98dd70-ceb5-4334-b958-85ff3c7aa8f4',
project: '/server/functions',
name: 'main',
functionArgs: {
x: 1,
y: 1 },
})
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
appId |
是 |
小程序 appId |
無 |
spaceId |
是 |
服務(wù)空間 ID |
無 |
project |
是 |
本地項(xiàng)目地址 |
無 |
name |
是 |
云函數(shù)名 |
無 |
functionArgs |
否 |
云函數(shù)參數(shù) |
{} |
返回
當(dāng)前云函數(shù)自身的返回
上傳云函數(shù)
示例代碼
const result = await alipaydev.deployCloudFunction({
appId: '2021001158675201',
spaceId: '02664190-6841-4f50-980a-12121504a807',
project: '/server/functions/demo' name: 'demo'})
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
appId |
是 |
小程序 appId |
無 |
spaceId |
是 |
服務(wù)空間 ID |
無 |
project |
是 |
本地項(xiàng)目地址 |
無 |
name |
是 |
云函數(shù)名 |
無 |
desc |
否 |
云函數(shù)描述 |
無 |
返回
屬性 |
類型 |
說明 |
name |
string |
云函數(shù)名稱 |
deploymentId |
string |
部署 ID |
下載云函數(shù)
示例代碼
const result = await alipaydev.downloadCloudFunction({
appId: '2021001158675201',
spaceId: '02664190-6841-4f50-980a-12121504a807',
name: 'demo',
path: '/server/functions/',
unzip: true})
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
appId |
是 |
小程序 appId |
無 |
spaceId |
是 |
服務(wù)空間 ID |
無 |
name |
是 |
云函數(shù)名 |
無 |
path |
是 |
保存路徑 |
無 |
unzip |
否 |
下載后,是否自動(dòng)解壓 |
false |
返回
屬性 |
類型 |
說明 |
stat |
string |
下載狀態(tài),stat 為 ok 代表成功 |
code |
string |
錯(cuò)誤碼 |
message |
string |
提示信息 |
密鑰生成
示例代碼
const { privatePem, publicPem } = await alipaydev.createKey({
type: 'rsa2',
scheme: 'pkcs8'})
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
type |
否 |
密鑰類型(rsa2/rsa) |
rsa2 |
scheme |
否 |
密鑰格式(pkcs8/pkcs1) |
pkcs8 |
pubPath |
否 |
公鑰保存地址 |
無 |
priPath |
否 |
私鑰保存地址 |
無 |
返回
屬性 |
類型 |
說明 |
privatePem |
string |
私鑰 |
publicPem |
string |
公鑰 |
密鑰匹配檢測(cè)
示例代碼
privatePem: '',
publicPem: ''})
入?yún)?/h3>
參數(shù) |
必填 |
說明 |
默認(rèn)值 |
privatePem |
是 |
私鑰 |
無 |
publicPem |
是 |
公鑰 |
無 |
更多建議: