APSocial

立即使用

概述

微信简介

支付宝分享是指第三方移动应用通过接入该功能,让用户可以分享图片、网页至支付宝。

分享功能已向全体开发者开放,开发者在支付宝开放平台账号下申请App并通过审核后,将对应SDK集成至开发者移动端应用中,通过调用该接口即可实现分享到支付宝。详情参考 支付宝分享

APSocial 模块概述

本模块封装了分享到支付宝的原生 SDK,集成了支付宝分享功能;可分享内容到朋友圈或好友等功能;轻松、高效集成支付宝功能到自己的 app 内。使自己的 app 和支付宝实现无缝链接。

模块使用攻略

第一步:创建应用

要在您的应用中使用支付宝开放产品的接口能力,您需要先去支付宝开放平台(open.alipay.com),在开发者中心中创建登记您的应用,并提交审核,审核通过后会为您生成应用唯一标识(APPID),并且可以申请开通开放产品使用权限,通过APPID您的应用才能调用开放产品的接口能力。需要详细了解开放平台创建应用步骤请参考《开放平台应用创建指南》。

第二步:配置 config.xml 文件

使用此模块之前建议先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:

  • 名称:APSocial
  • 参数:urlScheme、apiKey、apiSecret
  • 配置示例:
  <feature name="APSocial">
  <param name="androiidAppId" value="123456789"/>
    <param name="urlScheme" value="ap123456789"/>
    <param name="urlSchemeIdentifier" value="alipayShare"/> 
  </feature>
  • 字段描述:

    androiidAppId:(必须配置)支付宝开放平台获取的安卓端AppId

    urlScheme:(必须配置)用于实现应用间跳转及数据交换,本应用可以启动支付宝客户端,也可以从支付宝客户端跳回本应用。urlScheme 的 value 值是从第一步从支付宝开放平台获取的 appid 拼接而来,拼接规则是 命名规则:'ap'+APPID,如:ap123456789。

    urlSchemeIdentifier:(必须配置)必须为 alipayShare

iOS 平台上必须添加白名单,如下:

  <preference name="querySchemes" value="alipayshare,alipay,alipaytlshare" />

关于白名单解释详情参考 APICloud 官方文档之-----白名单配置

模块接口

isAPAppInstalled

判断当前设备是否安装支付宝客户端

isAPAppInstalled(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    installed: true      //布尔型;true||false,当前设备是否安装支付宝客户端
}

示例代码

var APSocial = api.require('APSocial');
APSocial.isAPAppInstalled(function(ret, err) {
    if (ret.installed) {
        alert("当前设备已安装支付宝客户端");
    } else {
        alert('当前设备未安装支付宝客户端');
    }
});

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本

isAPAppSupportShareTimeLine

判断当前支付宝客户端是否支持分享到朋友圈

isAPAppSupportShareTimeLine(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否支持
}

示例代码

var APSocial = api.require('APSocial');
APSocial.isAPAppSupportShareTimeLine(function(ret, err) {
    if (ret.status) {
        alert("支持");
    } else {
        alert('不支持');
    }
});

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本

shareText

分享文本内容

shareText({params}, callback(ret, err))

params

text:

  • 类型:字符串
  • 描述:分享的文本

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //0(成功) 
                //-1(未知错误)
                //-2(用户取消)
                //-3(发送失败)
                //-4(授权拒绝)
                //-5(不支持)
}

示例代码

var APSocial = api.require('APSocial');
APSocial.shareText({ 
    text: '我分享的文本'
}, function(ret, err) {
    if (ret.status) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本

sharePhoto

分享照片

sharePhoto({params}, callback(ret, err))

params

title:

  • 类型:字符串
  • 描述:分享的照片标题

description:

  • 类型:字符串
  • 描述:分享的照片描述

thumb:

  • 类型:字符串
  • 描述:分享的照片的缩略图路径,支持fs://、widget://、http://

imageUrl:

  • 类型:字符串
  • 描述:分享的照片路径,支持fs://、widget://、http://

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //0(成功) 
                //-1(未知错误)
                //-2(用户取消)
                //-3(发送失败)
                //-4(授权拒绝)
                //-5(不支持)
}

示例代码

var APSocial = api.require('APSocial');
APSocial.sharePhoto({ 
    title: '我分享的网页',
    description: '这是一个云平台',
    thumb: 'https://www.apicloud.com/user_icon/70/22/70220543f9eddf634cc246eae6b3e377.65x65.jpg',
    imageUrl:'http://www.apicloud.com/img/bill/cerIcon.png'
}, function(ret, err) {
    if (ret.status) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本

shareWeb

分享网页

shareWeb({params}, callback(ret, err))

params

title:

  • 类型:字符串
  • 描述:分享的网页标题

description:

  • 类型:字符串
  • 描述:分享的网页描述

thumb:

  • 类型:字符串
  • 描述:分享的网页的缩略图路径,支持fs://、widget://、http://

url:

  • 类型:字符串
  • 描述:分享的网页地址

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                //错误码:
                //0(成功) 
                //-1(未知错误)
                //-2(用户取消)
                //-3(发送失败)
                //-4(授权拒绝)
                //-5(不支持)
}

示例代码

var APSocial = api.require('APSocial');
APSocial.shareWeb({ 
    title: '我分享的网页',
    description: '这是一个云平台',
    thumb: 'https://www.apicloud.com/user_icon/70/22/70220543f9eddf634cc246eae6b3e377.65x65.jpg',
    url:'https://www.apicloud.com'
}, function(ret, err) {
    if (ret.status) {
        alert('分享成功');
    } else {
        alert(err.code);
    }
});

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本