接入指南

注册成为百度开发者

接入到百度云推送的第一个步骤是注册成为百度开发者,请参考文档 注册为百度开发者来完成百度开发者的注册步骤。

如果您在登陆后进入管理控制台出现如下图的提示,说明您的百度账号还没有注册为开发者账号

进入控制台并创建应用

在首页登陆已经注册为开发者的百度账号,然后点击开始使用或右上角的"我的控制台"进入推送控制台

进入推送控制台会进入应用列表页,应用列表页展示目前您在百度开发者中心曾经创建过的所有应用;如果您曾经在旧版管理控制台配置过的应用,新版管理控制台将可以直接使用;对于新创建或从未配置过的应用,则需要进行应用配置之后才可以进行消息发送等操作。

当您需要创建新的应用,请点击应用列表页中的创建应用按钮

随后请为您的应用命名。应用名称可以是中文,数字或英文字母的组合,最长32字符。注意应用名称符合相当法律法规并遵守“云推送”开发者服务协议

创建成功后,可以立刻进行应用配置,也可以稍后通过应用列表中的链接进入。

应用配置

如果您是第一次进行某个应用的应用配置,则需要您选择应用的平台(Android/iOS)。在本次配置保存完毕后,应用的平台将不可以更改,请谨慎操作

Android应用配置

安卓应用需要配置应用的包名。包名的要求如下

  • 只可以包含大写字母(A到Z)、小写字母(a到z)、数字和下划线、中文,可以用英文句号分隔

  • 每段标识必须以字母或下划线或中文开头

  • 至少包含两段标识符即至少包含一个英文句号

  • 不可包含Java保留字

  • 两段标识符之间有且只能有一个英文句号

iOS应用配置

iOS的应用配置包含以下几个部分

  • 选择应用目前的默认推送模式

    iOS应用根据编译过程中采用的证书不同分为开发版应用和生产版应用,两种类型的应用之间消息推送不能互通,即使用开发版证书的应用无法收到以生产版证书的推送,反之亦然。这里的配置会影响iOS推送时的默认应用(使用的证书)类型

  • 证书上传

    如上述,您需要为iOS应用上传对应的开发版证书和生产版证书,这里要求应用至少上传默认推送模式对应的类型的证书才可以进行应用配置保存操作。

损坏的、过期的证书都会造成证书上传的失败,如果出现此类问题,请获取正确的iOS证书后重新上传

获取应用的ApiKey/SecretKey

ApiKey是应用标识,在SDK调用过程中唯一标识一个应用 SecretKey是调用API时的Token,用来验证请求的合法性,请注意保密

ApiKey/SecretKey 在应用创建完毕后可以在应用详情页中查到

如果您的SecretKey泄露导致风险,请联系我们以重置SecretKey

下载Demo客户端

Android客户端

应用创建完毕后,在应用详情页可以找到该应用的Demo客户端的下载链接进行安装(也可以通过二维码扫描方式安装到手机)。

Demo是使用您当前应用的ApiKey进行创建的,默认可以接收到当前应用的广播消息和针对安装Demo的设备的单播消息。推送单播消息时需要使用到设备的ChannelID,可以通过打开Demo查看到,如下图所示

通过在Demo中点击设置标签,可以给当前设备打上一个标签。您可以通过推送控制台或者SDK对您设置的标签进行标签组播的推送,所有设置为相同标签名称的设备都会收到该标签名的标签组播推送。

iOS客户端

iOS客户端暂时不提供直接的Demo下载。如果您需要一个iOS客户端用于测试,请参考iOS开发文档来编译一个iOS客户端

开始进行推送

如果您需要使用管理控制台进行推送,请参考管理控制台文档。 如果您需要使用服务端SDK进行推送,请参考相关SDK开发文档。