= 平台接口设计 =


== 平台注册接口(魔方专供) ==

接口地址：
{{{
  http://pns.imofan.com/sender/register
}}}

接口请求参数定义：
||参数名||说明||
||appkey||应用的唯一标识id，由魔方系统生成||

注意：
* 参数必须用POST方式提交
* 平台提供给客户端的api包发出请求的user-agent固定为：imofan pns client，若判断user-agent不匹配，则不予注册
  
接口响应JSON格式定义：
{{{
  {
    "stat":      1,
    "appsecret": "h4534getr34re",
    "info":      "注册失败时的额外信息"
  }
}}}

返回值定义：
||返回值||说明||
||stat||取值为：1 注册成功，0 已注册过，-1 注册失败||
||appsecret||第三方应用服务端验证密码，进行推送时使用||
||info||包含额外的说明信息，用于stat为-1时平台所给的错误提示||


== 设备注册接口 ==

接口地址：
{{{
  http://pns.imofan.com/receiver/register
}}}

接口请求参数定义：
||参数名||说明||
||appkey||应用的唯一标识id，由魔方系统生成||
||devinfo||设备信息，用于生成设备udid||

注意：
* 参数必须用POST方式提交
* 平台提供给客户端的api包发出请求的user-agent固定为：imofan pns client，若判断user-agent不匹配，则不予注册
  
接口响应JSON格式定义：
{{{
  {
    "stat": 1,
    "udid": "f432e552242535353",
    "pwd":  "12345678",
    "info": "注册失败时的额外信息"
  }
}}}

返回值定义：
||返回值||说明||
||stat||取值为：1 注册成功，0 已注册过，-1 注册失败||
||udid||推送平台分配给该设备的唯一标识，登录推送平台时作为用户名使用，仅当stat==-1时，返回值为||
||pwd||客户端登录推送平台时的密码||
||info||包含额外的说明信息，用于stat为-1时平台所给的错误提示||


== 获取推送Token接口 ==

接口地址：
{{{
  http://pns.imofan.com/app/token
}}}

接口请求参数定义：
||参数名||说明||
||appkey||应用的唯一标识id，由魔方系统生成||
||udid||推送平台分配给该设备的唯一标识||
||pwd||客户端登录推送平台时的密码||

注意：
* 参数必须用POST方式提交
* 平台提供给客户端的api包发出请求的user-agent固定为：imofan pns client，若判断user-agent不匹配，则不予分配token
  
接口响应JSON格式定义：
{{{
  {
    "stat": 1,
    "token": "64tru67554fdwe12d",
    "info": "分配token失败时的额外信息"
  }
}}}

返回值定义：
||返回值||说明||
||stat||取值为：1 Toekn分配成功，-1 分配失败||
||token||推送平台分配给该客户端的推送Token，仅当stat==-1时，返回值为||
||info||包含额外的说明信息，用于stat为-1时平台所给的错误提示||


== 消息推送接口 ==

接口地址：
{{{
  http://pns.imofan.com/sender/push
}}}

接口请求参数定义：
||参数名||说明||
||appkey||应用的唯一标识id，由魔方系统生成||
||appsecret||应用服务端验证密码||
||token||推送平台分配给该客户端的推送Token||
||message||要推送的消息||

注意：
* 参数必须用POST方式提交
* 平台提供给应用服务端的api包发出请求的user-agent固定为：imofan pns server，若判断user-agent不匹配，则不予注册
  
接口响应JSON格式定义：
{{{
  {
    "stat": 1,
    "info": "分配token失败时的额外信息"
  }
}}}

返回值定义：
||返回值||说明||
||stat||取值为：1 推送成功，0 延迟推送（设备不在线），-1 推送失败，-2 Token已失效||
||info||包含额外的说明信息，用于stat为-1时平台所给的错误提示||