readme.txt 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. 唯品会开放平台(vop.vip.com)SDK使用说明书
  2. 1)内容说明
  3. ┬ src/Osp 底层通讯协议源码
  4. └ src/* 服务帮助类源码
  5. 2)使用说明
  6. 直接将src目录下所有内容引入到项目中即可。
  7. 3)关键字段说明
  8. appkey:创建应用时生成,为接口调用凭证之一
  9. appsecret:创建应用时生成,为接口调用凭证之一
  10. accessToken:通过Oauth认证授权时生成,参考:http://vop.vip.com/doccenter/viewdoc/33
  11. sign:调用签名,建议在异常捕获中记录该值,可以提高开放平台定位异常的效率,具体生成规则参考:http://vop.vip.com/doccenter/viewdoc/8#A4
  12. 4)调用示例
  13. 将sdk引入到项目中后,可根据以下demo测试应用访问权限和连通性。
  14. <?php
  15. require_once 'vipapis/address/AddressServiceClient.php';
  16. $ctx = null;
  17. try {
  18. //1、获取服务客户端
  19. $service = \vipapis\address\AddressServiceClient::getService();
  20. //2、设置系统级调用参数,只需在程序开始调用前设置一次即可
  21. $ctx = \Osp\Context\InvocationContextFactory::getInstance ();
  22. $ctx->setAppKey("appKey");//替换为你的appKey
  23. $ctx->setAppSecret("appSecret");//替换为你的appSecret
  24. //$ctx->setAccessToken("accessToken");//替换为你的accessToken,通过Oauth认证时必填
  25. $ctx->setAppURL("http://sandbox.vipapis.com/");//沙箱环境
  26. //$ctx->setAppURL("https://gw.vipapis.com/");//正式环境
  27. //$ctx->setTimeOut(30)//超时时间,可选,默认30秒
  28. //3、调用API及返回
  29. $rtn = $service->getProvinceWarehouse(\vipapis\address\Is_Show_GAT::SHOW_ALL);
  30. var_dump($rtn);
  31. } catch (\Osp\Exception\OspException $e) {
  32. //4、捕获异常
  33. var_dump($ctx->getSign());//获取最近一次调用的sign值
  34. }
  35. 5)FAQ
  36. a.调用失败?
  37. i.对于有明确返回错误信息的失败调用,请根据错误信息提示操作;
  38. ii.对于原因不明的失败,请通过开放平台的支持中心搜索解决方案或提交问题进行报障:https://vop.vip.com/support/index
  39. b.网络环境不稳定或超时?
  40. i.如果是正式环境,请确认调用参数AppUrl是否为https://gw.vipapis.com
  41. ii.若业务参数包含分页数据,请按照API在线文档(https://vop.vip.com/apicenter/index)的建议大小设置每页数据大小,一般建议每页数据在100以内
  42. iii.其他疑难问题,请通过开放平台的支持中心提交问题进行报障:https://vop.vip.com/support/index
  43. c.sdk如何升级?
  44. 可到开放平台下载sdk最新版本,:https://vop.vip.com/doccenter/viewdoc/20
  45. 建议下载新的sdk以后,替换src目录下所有内容,以保证sdk正常运行。