极光推送-服务端API开发

最新推荐文章于 2022-03-24 16:09:39 发布
最新推荐文章于 2022-03-24 16:09:39 发布
阅读量1.1k 收藏
点赞数 1
文章标签： 极光推送
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Kevin_ASL/article/details/100858333
版权

极光推送-服务端开发

参数:

https://docs.jiguang.cn

https://community.jiguang.cn

REST API 基本约束

API 被设计为符合HTTP,REST规范.例如:查询请求使用GET方法;提交请求使用POST请求.

API 资源列表

描述资源URL
推送消息APIPOST /v3/pushhttps://api.jpush.cn
操作Tag,AliasGET /v3/deviceshttps://device.jpush.cn
获取统计数据GET /v3/receivedhttps://report.jpush.cn

鉴权方式

  • 极光RSET API采用HTTP基本认证的验证方式.

  • 基本做法为: HTTP Header(头)里加Authorization:

Authorization: Basic $(base64_auth_string)
  • Header名称是”Authorization",值是Base64加密后的”username:password”.

在JPushAPI的场景里,username是appKey,密码是masterSecret.

  • 配置文件配置类
@Getter
@Component
@ConfigurationProperties("jpush")
public class JPushProperties {
  @ApiModelProperty("应用程序:app_key&&master_secret")
	private Map<String, Map<String, String>> applications = new HashMap<>(4);
  
  private String appKey;
  private String masterSecret;
  
  public void initProperties(JpushAppEnum appEnum) {
    Map<String, String> appMap = this.applications.get(appEnum.getCode());
    this.appKey = appMap.get("app_key");
    this.masterSecret = appMap.get("master_secret");
  }
}
  • 构建不同的HTTP请求
@Component
public class JpushUtils {
  private JpushUtils {}

  @Autowired
  private JPushProperties properties;
  
  private IHttpClient httpClient;
  /**
   * @param appEnum 应用(不同的应用有不同的appKey和masterSecret)
   */
  private synchronized IHttpClient initInstance(JpushAppEnum appEnum) {
    switch(appEnum) {
      case xxx:
        if (null != httpClient) {
          properties.initProperties(appEnum);
          String basicAuthorization = ServiceHelper.getBasicAuthorization(properties.getAppKey(), properties.getMasterSecret());
          // 使用ApacheHttpClient
          httpClient = new ApacheHttpClient(basicAuthorization, null, config);
        }
        break;
      case xxx:
        if (null != httpClient) {
          properties.initProperties(appEnum);
          String basicAuthorization = ServiceHelper.getBasicAuthorization(properties.getAppKey(), properties.getMasterSecret());
          // 使用NativeHttpClient(极光默认的HttpClient:JPushClient)
          httpClient = new NativeHttpClient(basicAuthorization, null, config);
        }
        break;
      case xxx:
        if (null != httpClient) {
          properties.initProperties(appEnum);
          String basicAuthorization = ServiceHelper.getBasicAuthorization(properties.getAppKey(), properties.getMasterSecret());
          // 使用NettyHttpClient
          httpClient = new NettyHttpClient(basicAuthorization, null, config);
        }
        break;
      default:
        if (null != httpClient) {
          properties.initProperties(appEnum);
          String basicAuthorization = ServiceHelper.getBasicAuthorization(properties.getAppKey(), properties.getMasterSecret());
          // 使用Http2Client
          httpClient = new Http2Client(basicAuthorization, null, config);
        }
        break
    }
  }
}

PUSH API

完全基于HTTPS,不再提供HTTP访问;

使用Http Basic Authentication的方式做访问授权.这样整个API请求可以使用常见的HTTP工具来完成;

推送内容完全使用JSON格式;

支持多tag的与或操作;可单独发送通知或者自定义消息,也可以同时推送通知与自定义消息.

推送对象

一个推送对象,以JSON格式表示,表示一条推送相关的所有信息.

关键字选项含义
platform必填推送平台设置
audience必填推送设备指定
notification可选通知内容体.与message二者必须有其一
message可选消息内容体.与notification二者必须有其一
sms_message可选短信渠道补充送达内容体
options可选推送参数
cid可选用于防止api调用端重试造成服务端的重复推送而定义的一个标识符
platform: 推送平台
  • JPush当前支持Android,ios,WindowsPhone.其中关键字为: “android”, “ios”, “winphone”
  • 注意: 如果目标平台为ios平台,推送Notification时需要在options中通过apns_production字段来设定推送环境.True表示推送生产环境,False表示要推送开发环境.如果不指定则为推送生产环境,一次只能推送给一个环境
audience: 推送目标
  • 推送设备对象,表示一条推送可以被推送到哪些设备列表.确认推送设备对象,JPush提供了多种方式,比如:别名,标签,注册ID,分群,广播等
关键字类型含义说明备注
allJSONArray全部设备.(广播)
tagJSONArrayOR数组.多个标签之间的OR的关系一个推送最多20个.每个tag的长度限制为40字节
tag_andJSONArrayAND数组.多个标签之间是AND的关系注意与tag的区别.一次推送最多20个
tag_notJSONArrayNOT数组.多个标签之间,先取多标签的并集,再对该结果取补集一次推送最多20个
aliasJSONArray别名数组.多个别名之间是OR关系一个设备只能绑定一个别名;一次推送最多1000个;每个alias的长度限制为40字节
Registration_idJSONArray注册ID数组.多个注册ID之间是OR关系设备标识.一次推送最多1000个,客户端集成SDK后可获取到该设备
notification: 通知
  • 通知对象.是一条推送的实体内容对象之一
  • alter : 通知的内容在各个平台上,都可能只有一个最基本的属性”alter”
message: 自定义消息
  • 应用内消息.(自定义消息,透传消息)
  • 此部分内容不会展示到通知栏上,JPushSDK收到消息内容后透传给APP,需要APP自行处理.
关键字类型选项含义
msg_contentstring必填消息内容本身
titlestring可选消息标题
content_typestring可选消息内容类型
extrasJSONObject可选JSON格式的可选参数

案例说明

  • 推送对象
@Data
private class JPushParam {
  private Platform platform;
  private Audience audience;
  private JPushMessage message;
}
  • 消息体
@Data
public class JPushMessage {
  private String title;
  private String msgContent;
  private String contentType;
  private Map<String, String> extras;
  private Map<String, JsonObject> jsonExtras;
}
  • 构建消息体
public class BuildPayloadUtils {
  public static PushPayload getPayload(JpushParam param) {
    JPushMessage message = param.getMessage();
    PushPayload.Builder pushBuilder = PushPayload.newBuilder();
    // 构建推送平台
    if (null != param.getPlatform) {
      pushBuilder.setPlatform(param.getPlatform());
    } else {
      pushBuilder.setPlatform(Platform.all());
    }
    // 构建推送目标
    if (null != param.getAudience) {
      pushBuilder.setAudience(param.getAudience());
    } else {
      pushBuilder.setAudience(param.all());
    }
    // 构建通知和自定义消息
    setMessageOrAlter(pushBuilder, message, PushWayEnum.ALL);
  }
  
  /**
   * @param wayEnum 通知和消息(只选其一还是两者都有)
   */
  private static void setMessageOrAlter(PushPayload.Builder pushBuilder, JPushMessage message, PushWayEnum wayEnum) {
        switch (wayEnum) {
            case ALL:
                pushBuilder.setNotification(Notification.newBuilder()
                        .setAlert(message.getMsgContent())
                        .addPlatformNotification(getAndroidNotificationBuilder(message).build())
                        .addPlatformNotification(getIosNotificationBuilder(message).build())
                        .build())
                        .setMessage(getMessageBuilder(message).build());
                break;
            case ALTER:
                pushBuilder.setNotification(Notification.newBuilder()
                        .setAlert(message.getMsgContent())
                        .addPlatformNotification(getAndroidNotificationBuilder(message).build())
                        .addPlatformNotification(getIosNotificationBuilder(message).build())
                        .build());
                break;
            case MESSAGE:
                pushBuilder.setMessage(getMessageBuilder(message).build());
                break;
            default:
                break;
        }
    }
  
  private static AndroidNotification.Builder getAndroidNotificationBuilder(JPushMessage message) {
        AndroidNotification.Builder androidBuilder = AndroidNotification.newBuilder();
        if (StringUtils.isNotEmpty(message.getTitle())) {
            androidBuilder.setTitle(message.getTitle());
        }
        if (StringUtils.isNotEmpty(message.getMsgContent())) {
            androidBuilder.setAlert(message.getMsgContent());
        }
        if (!CollectionUtils.isEmpty(message.getExtras())) {
            androidBuilder.addExtras(message.getExtras());
        }
        return androidBuilder;
    }

    private static IosNotification.Builder getIosNotificationBuilder(JPushMessage message) {
        IosNotification.Builder iosBuilder = IosNotification.newBuilder().incrBadge(1);
        if (StringUtils.isNotEmpty(message.getMsgContent())) {
            iosBuilder.setAlert(message.getMsgContent());
        }
        if (!CollectionUtils.isEmpty(message.getExtras())) {
            iosBuilder.addExtras(message.getExtras());
        }
        return iosBuilder;
    }
  
    private static Message.Builder getMessageBuilder(JPushMessage message) {
        Message.Builder messageBuilder = Message.newBuilder();
        if (StringUtils.isNotEmpty(message.getTitle())) {
            messageBuilder.setTitle(message.getTitle());
        }
        if (StringUtils.isNotEmpty(message.getMsgContent())) {
            messageBuilder.setMsgContent(message.getMsgContent());
        }
        if (!CollectionUtils.isEmpty(message.getExtras())) {
            messageBuilder.addExtras(message.getExtras());
        }
        if (!CollectionUtils.isEmpty(message.getJsonExtras())) {
            Map<String, JsonObject> jsonExtras = message.getJsonExtras();
            for (Map.Entry<String, JsonObject> entry : jsonExtras.entrySet()) {
                messageBuilder.addExtra(entry.getKey(), entry.getValue());
            }
        }
        return messageBuilder;
    }
}

注意: 推送的消息体有大小限制.Android平台Notification+Message长度限制为4000字节.IOS中Notification中“ios”:{}及大括号内的总体长度不超过2000字节.IOS的Message部分长度不超过4000字节.

  • 推送方法
private PushResult getPushResult(JPushAppEnum appEnum, PushPayload payload, String url) {
  PushResult result = null;
  try {
    ResponseWrapper response = httpClient.sendPost(url, payload.toString());
    result = BaseResult.fromResponse(response, PushResult,class);
  } catch (ApiConnectionException e) {
    log.error("[push] Connection error, should retry later", e);
    log.warn("[push] push again. start....");
    // 如果是因为连接超时导致推送失败,这里做个重新推送的操作(不过正常情况下,需要做下限制:比如多次推送都失败,就不应该让他一直重试.)
    getPushResult(appEnum, payload, url);
  } catch (APIRequestException e) {
    log.error("[push] Should review the error, and fix the request", e);
    log.error("[push] HTTP Status: " + e.getStatus());
    log.error("[push] Error Code: " + e.getErrorCode());
    log.error("[push] Error Message: " + e.getErrorMessage());
  }
  return result;
}
丶kingsMe
关注
极光推送的API
A70235的博客
01-20 1281
进行推送的关键在于构建一个 PushPayload 对象。这是极光官网API的一句话。 打开极光源码找到PushPayload 类 看到这几个属性，然后在极光网站上有对应的说明 其实 要做的就是按照自己的需求给这个几个属性设置值而已。 package com.cn.hnust.util; import org.slf4j.Logger; import org.
C#极光推送Push-API-V3服务端Demo
03-26
【C#极光推送Push-API-V3服务端Demo】是一个基于C#编程语言实现的，利用极光推送（JPush）API V3版本的服务端示例...通过这个C#极光推送服务端Demo，开发者可以快速上手，结合自己的业务需求，实现高效的消息推送服务。
极光推送API
09-17
强大的消息推送API接口,简单配置即可使用.....超方便!
极光推送 java api_JPush极光推送Java服务器端API
weixin_39705931的博客
02-15 148
方法名称参数列表(必须)方法说明setEnableSSLboolean enableSSL (true为使用ssl, 默认为不使用ssl)是否启动ssl安全连接sendNotificationWithImeiint sendNo(发送编号),String imei (IMEI字符串) ,String msgTitle (消息标题/通知标题),String msgContent (消息内容/通知内...
极光推送服务端开发
QingTian1234321的专栏
12-17 1079
1. 需求 因门户app开发需求，要求对从crm推送过来的新订单对用户进行定向推送提醒，使得相关人员能够及时处理订单 2. 实现方案 使用极光推送作为推送服务，极光推送为免费版即可满足需求，如果后期推送量大，可申请使用付费版本。极光推送分为客户端开发和服务端开发。客户端有android和ios相关开发人员参照极光官网官方文档完成对app的开发集成。而服务端采用调用REST API v3 –
极光推送服务端实现
zxc8471的专栏
09-09 3736
因为暂时开发自有对单一用户不同设备进行信息推送。 因此就简单实现了两个接口，可能后期项目完善会增加一些其他接口也不会太难。 极光推送已经把接口编写的简单至极，一个简单的例子就可以实现。但是会有很多参数有他不同的含义，可以参照：极光推送接口文档 接口代码：public interface PushPortal { /** * 推送所有平台所有用户 * @return
极光推送服务端(java)所需jar
02-18
极光推送服务端（JPush Server）是针对Java开发者提供的一款服务端SDK，主要用于实现应用程序向用户设备发送消息和通知的功能。极光推送是移动应用开发者首选的推送服务之一，它能够帮助开发者轻松地实现向iOS、...
极光推送服务端代码及所需jar文件
03-27
本压缩包包含的是极光推送服务端的代码及其运行所依赖的jar文件，这对于我们理解和部署极光推送服务端具有重要意义。 首先，`jpush-client-3.2.3.jar` 是极光推送SDK的核心客户端库，主要用于服务端与极光推送...
极光推送 java服务器demo、Android客户端demo
01-05
7. 其他功能：DEMO可能还包含了设置推送开关、处理离线消息等功能，这些都是极光推送客户端开发中常见的场景。 通过这两个DEMO，开发者能够深入理解极光推送的服务器端与客户端交互流程，从而在实际项目中更有效地...
极光推送服务端（java）所需jar包
03-13
极光推送服务端（Java）所需jar包是一个关键组件，用于构建基于Java的应用程序，以实现与极光推送（JPush）服务器进行交互，提供消息推送、设备管理、用户分组等核心功能。极光推送是中国领先的移动消息推送平台，为...
极光推送java端API
12-18
极光推送java端API
极光推送服务器端代码
09-23
定位服务AGPS：辅助全球卫星定位系统（英语：Assisted Global Positioning System，简称：AGPS）是一种GPS的运行方式。它可以利用手机基地站的资讯，配合传统GPS卫星，让定位的速度更快。用中文来说应该是网络辅助 GPS定位系统。通俗的说AGPS是在以往通过卫星接受定位信号的同时结合移动运营的GSM或者CDMA网络机站的定位信息，就是一方面由具有AGPS的手机获取来自卫星的定位信息，而同时也要靠该手机透过中国移动的GPRS网络下载辅助的定位信息，两者相结合来完成定位。与传统 GPS(GlobalPositioningSystem全球定位系统)首次定位要2、3分钟相比AGPS的首次定位时间最快仅需几秒钟，同时AGPS也彻底解决了普通GPS设备在室内无法获取定位信息的缺陷。
极光推送，角标实现，服务器，Android端完整Demo
06-13
本次实现了用户登录注册，将用户保存到Application 里面实现用户持久化，用户有已读消息查看，未读消息查看，发送消息功能，未读消息读取后，添加到已读消息里面，发送消息具有 推送功能 可以全部发送，和选择人员发送，发送消息过后，如果当前用户在线会收到一条任务栏通知，点击通知可以查看到该消息，登录App时 ，APP应用会生成，未读信息角标，（实现了vivo和小米。
极光推送JPush服务器端集成SDK
12-11
请看博客介绍：http://blog.csdn.net/shakespeare001/article/details/50266875
Android 极光推送API
晨曦
05-18 2012
前言 发现现在的Android开发中很少有不用第三方SDK的，为什么呢？就是因为实现一个功能的速度快呀，比如说客服、聊天、直播等一些功能，用第三方SDK可以最快解决问题，我在实际开发中也对接过很多SDK，不过仔细写过这方便到的博客，前段时间我写了一个关于udesk SDK的文章，实现IM的，写的不算太详细，不过你如果看了也够用了，好了，进入正文。 正文 今天要对接的这个SDK是极光系列中的推送服务SDK，当然极光还有其他的服务，进入极光官网了解一下，我这里放个图说明一下 主要看我标注的这个，因为主要讲这个
极光推送api
fishmai的专栏
08-01 7063
Push API v3 这是 Push API 最近的版本。 相比于 API v2 版本，v3 版本的改进为： 完全基于 https，不再提供 http 访问；使用 HTTP Basic Authentication 的方式做访问授权。这样整个 API 请求可以使用常见的 HTTP 工具来完成，比如：curl，浏览器插件等；推送内容完全使用 JSON 的格式；支持的功能有所改进：支持
Andorid极光推送API全角和
pdw2009的专栏
08-20 1942
最佳入门文章 http://www.cnblogs.com/zkun/p/4315593.html Jpush  adnroid API简介 获取集成日志 API - setDebugMode 用于开启调试模式，可以查看集成JPush过程中的log，如果集成失败，可方便定位问题所在 接口定义 window.plugins.jPushPlugin
极光推送在APICloud平台的使用教程
weixin_43947457的博客
03-23 829
推送服务是app应用中非常重要的一个服务，尤其对于app开发者而言，没有什么途径比消息推送更能直接、即时地触及到目标用户群体。根据相关数据显示，通过推送服务可以显著提升app的用户粘性和活跃度。 下面我们就为大家讲解一下，如何在APICloud开发平台使用推送功能。 jpushVip模块封装了极光推送平台的SDK，使用此模块可实现接收推送通知和透传消息功能。和APICloud平台的推送功能相似，都支持在线推送，但是如果要支持离线推送，需要集成极光厂商通道。 使用极光推送基本流程说明： 1、在极光推送网站（
极光笔记｜极光推送在APICloud平台的使用教程
weixin_57579230的博客
03-24 3834
推送服务是App应用中非常重要的一个服务，尤其对于App开发者而言，没有什么途径比消息推送更能直接、即时地触及到目标用户群体。根据相关数据显示，通过推送服务可以显著提升App的用户粘性和活跃度。本期极光笔记就为大家讲解下，如何在APICloud开发平台使用推送功能。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值