支付寶小程序API 小程序二維碼

2018-10-25 16:32 更新

支付寶小程序API小程序二維碼

詳細小程序二維碼參考指引

alipay.open.app.qrcode.create

生成小程序推廣二維碼

請求地址

環(huán)境 HTTPS請求地址
正式環(huán)境 https://openapi.alipay.com/gateway.do

公共請求參數(shù)

名稱 類型 必填 描述
app_id String 支付寶分配給開發(fā)者的應(yīng)用ID
method String 接口名稱
format String 僅支持JSON數(shù)
charset String 請求使用的編碼格式,如utf-8,gbk,gb2312等
sign_type String 商戶生成簽名字符串所使用的簽名算法類型,目 前支持RSA2和RSA,推薦使用RSA2
sign String 商戶請求參數(shù)的簽名串,詳見簽名
timestamp String 發(fā)送請求的時間,格式"yyyy-MM-dd HH:mm:ss"
version String 調(diào)用的接口版本,固定為:1.0
app_auth_token String 詳見應(yīng)用授權(quán)概述
biz_content String 請求參數(shù)的集合,最大長度不限,除公共參數(shù)外所有請求參數(shù)都必須放在這個參數(shù)中傳遞,具體參照各產(chǎn)品快速接入文檔

請求參數(shù)

名稱 類型 必填 示例 描述
url_param String page/component/component-pages/view/view 小程序中能訪問到的頁面路徑
query_param String x=1 小程序的啟動參數(shù),打開小程序的query,在小程序onLaunch的方法中獲取
describe String 二維碼描述 對應(yīng)的二維碼描述

公共響應(yīng)參數(shù)

名稱 類型 必填 描述
code String 網(wǎng)關(guān)返回碼
msg String 網(wǎng)關(guān)返回碼描述
sub_code String 網(wǎng)關(guān)明細返回碼
sub_msg String 網(wǎng)關(guān)明細返回碼描述
sign String 簽名

響應(yīng)參數(shù)

名稱 類型 必填 描述
qr_code_url String 二維碼圖片鏈接地址

代碼示例

java版本

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenAppQrcodeCreateRequest request = new AlipayOpenAppQrcodeCreateRequest(); 
request.setBizContent("{" +
"\"url_param\":\"/index.html?name=ali&loc=hz\"," + "\"query_param\":\"name=1&age=2\"," + "\"describe\":\"二維碼描述\"" +
" }");
AlipayOpenAppQrcodeCreateResponse response = alipayClient.execute(request); 
if(response.isSuccess()){
    System.out.println("調(diào)用成功");
} else {
    System.out.println("調(diào)用失敗");
}

php版本

$aop = new AopClient ();
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do'; 
$aop->appId = 'your app_id';
$aop->rsaPrivateKey = '請?zhí)顚戦_發(fā)者私鑰去頭去尾去回車,一行字符串'; 
$aop->alipayrsaPublicKey='請?zhí)顚懼Ц秾毠€,一行字符串';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset ='GBK';
$aop->format ='json';
$request = new AlipayOpenAppQrcodeCreateRequest (); 
$request->setBizContent("{"."\"url_param\":\"/index.html?name=ali&loc=hz\","."\"query_param\":\"name=1&age=2\","."\"describe\":\"二維碼描述\""." }");
$result = $aop->execute ( $request);
$responseNode = str_replace(".","_",$request->getApiMethodName())."_response"; 
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
    echo "成功";
} else {
    echo "失敗"; 
}

.Net版本

IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "app_id", "merchant_private_key", "json", "1.0", "RSA2", "alipay_public_key", "GBK", false); 
AlipayOpenAppQrcodeCreateRequest request= new AlipayOpenAppQrcodeCreateRequest(); request.BizContent="{" +
"\"url_param\":\"/index.html?name=ali&loc=hz\"," + "\"query_param\":\"name=1&age=2\"," + "\"describe\":\"二維碼描述\"" +
" }";
AlipayOpenAppQrcodeCreateResponse response=client.Execute(request); 
Console.WriteLine(response.Body);

HTTP版本

https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=alipay.open.app.qrcode.create&app_id=2893&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&biz_content=
{"url_param":"/index.html?name=ali&loc=hz", "query_param":"name=1&age=2", "describe":"二維碼描述"} 
//為確保安全通信,需自行驗證響應(yīng)示例中的sign值是否為螞蟻金服所提供。

響應(yīng)示例

json示例

{
    "alipay_open_app_qrcode_create_response": {
        "code": "10000",
        "msg": "Success",
        "qr_code_url": "http://mmtcdp.stable.alipay.net/wsdk/img?fileid=A*lSbPT5i9C1wAAAAAAAAAAABjAQAAAA&t=9005d7f574f30246b89c20c17302115f&bz=mmtcafts&"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

異常示例

json示例

{
    "alipay_open_app_qrcode_create_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系統(tǒng)繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

業(yè)務(wù)錯誤碼

公共錯誤碼

錯誤碼 錯誤描述 解決方案
INVALID_PARAMETER 參數(shù)有誤 檢查請求參數(shù)是否傳入
APPQRCODE_NOT_TINYAPP 非小程序應(yīng)用類型 檢查app應(yīng)用類型,本接口只支持小程序的應(yīng)用
SYSTEM_ERROR 系統(tǒng)繁忙 稍后重試
APP_QUERY_ERROR 應(yīng)用查詢錯誤 確認應(yīng)用是否存在,如果應(yīng)用存在,則稍后重試
以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號