README

欢迎使用个推PUSH SDK For PHP。

个推PUSH SDK For PHP的主要目标是提升开发者在服务端集成个推推送服务的开发效率。开发者不需要进行复杂编程即可使用个推推送服务的各项常用功能，SDK可以自动帮您满足调用过程中所需的鉴权、组装参数、发送HTTP请求等非功能性要求。

下面向您介绍个推PUSH SDK For PHP的使用方法。

环境要求

需要配合PHP 5.5或其以上版本。
使用个推PUSH SDK前，您需要先前往个推开发者中心完成开发者接入的一些准备工作，创建应用。详细见操作步骤
准备工作完成后，前往个推开发者中心获取应用配置，后续将作为使用SDK的输入。详细见操作步骤

快速开始

普通调用

下列代码示例向您展示了使用个推Push SDK For PHP调用一个API的3个主要步骤：

设置参数，创建API。
发起API调用。
处理响应。

使用示例：推送API_根据cid进行单推

function pushToSingleByCid(){
	//创建API，APPID等配置参考 环境要求 进行获取
    $api = new GTClient("https://restapi.getui.com","APPKEY", "APPID","MASTERSECRET");
    //设置推送参数
    $push = new GTPushRequest();
    $push->setRequestId("请求唯一标识号");
    $message = new GTPushMessage();
    $notify = new GTNotification();
    $notify->setTitle("设置通知标题");
    $notify->setBody("设置通知内容");
    //点击通知后续动作，目前支持以下后续动作:
    //1、intent：打开应用内特定页面url：打开网页地址。2、payload：自定义消息内容启动应用。3、payload_custom：自定义消息内容不启动应用。4、startapp：打开应用首页。5、none：纯通知，无后续动作
    $notify->setClickType("none");
    $message->setNotification($notify);
    $push->setPushMessage($message);
    $push->setCid("CID");
    //处理返回结果
    $result = $api->pushApi()->pushToSingleByCid($push);
}

使用示例：统计API_获取单日推送数据

function queryPushResultByDate(){
    //创建API，APPID等配置参考 环境要求 进行获取
    $api = new GTClient("https://restapi.getui.com","APPKEY", "APPID","MASTERSECRET");
    //处理返回结果
    $result = $api->statisticsApi()->queryPushResultByDate("年-月-日");
}

使用示例：用户API_查询用户状态

function queryUserStatus(){
    //创建API，APPID等配置参考 环境要求 进行获取
    $api = new GTClient("https://restapi.getui.com","APPKEY", "APPID","MASTERSECRET");
    $array = array(CID1);
    //处理返回结果
    $result = $api->userApi()->queryUserStatus($array);
}

其余功能可参考该链接

设置代理

我们提供系统环境变量的方式进行代理配置，当需要使用代理进行http访问时，配置以下环境变量

        "getui_http_proxy_ip" ： 代理ip
        "getui_http_proxy_port" ： 代理端口
        "getui_http_proxy_username" ： 鉴权用户名
        "getui_http_proxy_passwd" ： 鉴权密码

已支持的API列表

以下是消息推送功能与推送API的对应关系

注：更多API持续更新中，敬请期待。

其他链接

个推开发者平台

sunkangchina / getui-pushapi-php-client-v2

Maintainers

Details