全栈工程师-咨询电话:15675178605 (微信同号)

【PHP】 API/SDK,Demo文件下载与应用说明

【PHP】 API/SDK的Demo详细说明与演示了,PHP怎么获取签名RndKey,怎么调用商城各系统的API。SDK中封装好了加密签名方法与Http请求方法。用户只需调用即可,无需自己实现签名加密与Http方法。

一、【PHP】 API/SDK的Demo下载

下载地址: http://down.opencodetiger.com/PHPApiSdk_OctShop.zip

二、【PHP】 API/SDK使用说明

1、将下载的压缩文件 PHPApiSdk_OctShop.zip 进行解压。得到 PHP 项目文件夹。

2、在目录【 \PHPApiSdk\ 】中找到文件【BusiEnter.php】。

三、【BusiEnter.php】 文件说明

1、BusiEnter.php文件中封装了,加密签名,Http请求的函数,用户调用即可使用。

2、公共变量,OctCommonCodeSystemWeb_ApiDomain,ApiUrl_GetRndKeyRSA,mUserKeyID,mUserKey 需要根据自身搭建商城时的配置参数进行赋值。OctCommonCodeSystemWeb_ApiDomain 是 OctCommonCodeSystemWeb (各项目通用代码项目)配置的域名地址,如: http://cc.opencodetiger.com 。mUserKeyID,mUserKey 两参数可以在商城的平台管理系统中,【系统管理】->【API接口管理】->【API用户管理】 进行设置与查找。

3、函数:testApiDemo() 是测试调用【加载买家用户的 账号,买家信息,余额积分信息 API接口】的实例。请求接口成功后,会显示一长串Json字符串。

4、函数: httpRndKeyRsa($pHttpUrl, $pVerifyType, $PostParamArr)  是封装了签名加密的Http请求方法,以POST方式发送,商城各系统的API接口都可以使用这个方式发送Http请求。

参数说明:
$pHttpUrl -> 接口的URL地址,如:http://192.168.3.10:8001/User/UserAccount。
$pVerifyType -> Http验证类型,具体的API接口里面有说明。如:UGS_UserAccount。
$PostParamArr -> API接口的参数,以Array()类型进行添加即可。
API接口请求成功后,就会返回一长串Json字符串。

特别注意:商城各系统API接口的Http请求都用这个方法即可。如果不使用那么就需要自己实现签名加密。

四、特别注意: getRndKeyRSA() 获取RndKeyRSA 签名加密

1、RndKeyRSA 这个签名加密的Key参数,调用商城的每一个API接口都需要传递,里面包括了签名加密验证信息,是判断API接口请求是 否合法的依据。 

2、RndKeyRSA 值一般是两个小时内有效,超过了两个小时,就需要重新获取,重新获取后再把RndKeyRSA 值传递到接口参数中去。

3、为了提高系统的性能,请在getRndKeyRSA()函数中,实现保存与更新RndKeyRSA值到文件中的功能,即RndKeyRSA 获取成功后,将其保存到某个文件中,并带上获取的时间信息, 如果文件中存在有效没有超时的RndKeyRSA值 ,那么,直接读取文件中的RndKeyRSA值即可。如果超时了,则重新发送Http获取,并保存更新到文件中。 这样就不需要每次调用接口时都请求服务器生成RndKeyRSA。 大大降低系统的并发。 

4、 【PHP】 API/SDK的Demo 并没有实现RndKeyRSA保存到文件中,请用户自己实现,这对提高系统性能非常重要。如果不知道怎么做,请联系【OctShop全栈工程师】解决。

5、其他项目如果需要引用此SDK函数,请将文件夹【PHPApiSdk】中,  BusiEnter.php,RsaEncryptClass.php 文件复制到需要引用的项目文件中。

五、商城具体的API接口调用,请参考各系统API接口详细说明,有疑问请咨询【官网全栈工程师】。