【SDK接入】马蜂窝开放平台SDK使用说明
1. 概述
马蜂窝开放平台 SDK 提供了请求数据加密解密、签名、API请求、接口返回信息解析和同步信息解析的功能。使用 SDK 可以很方便的实现与马蜂窝开放平台进行对接。
2. SDK使用环境依赖
- PHP SDK 需要依赖 PHP 5 及以上的环境
3. 下载地址
http://openapi.mafengwo.cn/deals/demo/v2/phpdemo.zip
4. SDK 详细介绍
4.1 接口描述
以下接口都需要根据相关参数实例化对象才能调用
·请求接口(MSDK_Php_Openapi):
接口参数:action:请求动作,data:业务请求参数,accessToken:令牌(选填,不填直接实时获取)
返回参数:bool成功或者失败
ps:获取请求结果:$obj→getLastData(),获取请求错误码:$obj→getLastErrno(),获取错误信息:$obj→getLastError()
·解析马蜂窝返回结果(MSDK_Php_Openapi):
接口名称:parseRes()
接口参数:data:马蜂窝返回的参数
返回参数:bool解析成功或者失败
ps:获取请求结果:$obj→getLastData(),获取请求错误码:$obj→getLastErrno(),获取错误信息:$obj→getLastError()
·获取令牌接口(MSDK_Php_AccessToken):
接口名称:getAccessToken()
接口参数:无
返回参数:string令牌字符串
·解密/解密(MSDK_Php_MfwEncrypt):
接口名称:sEncryptData()/ aDecryptData()
接口参数:sData:需要解密解密数据 ,sKey:分配给商家的秘钥
·同步认证接口(MSDK_Php_OrderSyn):
接口名称:checkAuth()
接口参数:postData:马蜂窝post请求数据
返回参数:bool是否通过认证(签名认证)
·同步返回接口(MSDK_Php_OrderSyn):
接口名称:getReturn()
接口参数:isSuccess:是否成功,msg:错误信息(可选)
返回参数:string解密后的结果,直接返回即可
4.2 类描述
·请求接口类:MSDK_Php_Openapi
实例化时参数:无
提供的方法:send()、parseRes()
·获取令牌类:MSDK_Php_AccessToken
实例化时参数:无
提供的方法:getAccessToken()
·加密解密类:MSDK_Php_MfwEncrypt
静态类,直接调用方法
提供的方法:sEncryptData()/ aDecryptData()
·接收订单状态同步实现类:MSDK_Php_OrderSyn
实例化时参数:无
提供的方法:checkAuth(),getReturn()
·配置参数和固定常量类:MSDK_Php_Const
配置商户参数、定义常量
5. demo
具体请求内容可以在demo.php文件中查看。
下面以请求sales.order.list.get为例
1)配置请求参数
开发者需要在MSDK_Php_Const(Const.php)中配置CONFIG_PARTNERID、CONFIG_ASEKEY、CONFIG_CLIENT_SECRET者3个常量,该常量在seller后台查询
2)配置请求action
$action = 'sales.order.list.get';(demo.php中)
3)配置请求参数(demo.php)
$data = [];
$data['page_no'] = 1;
$data['page_size'] = 20;
4)实例化请求对象
$obj = new MSDK_Php_Openapi();
5)获取AccessToken(Access Token有一定的有效期,有效期内可以使用同一数据即可)
$objAccessToken = new MSDK_Php_AccessToken();
$accessToken = $objAccessToken->getAccessToken();
6)发送请求
$obj->send($action, $data);或者$obj->send($action, $data, $accessToken);
7)获取解密后的请求参数
$aData = $obj->getLastData();
6. 调用方式
只需在代码中引入即可,实例化相关类后直接调用方法,也可复制粘贴到自己系统。
赞同1