earnp/zmxy

Laravel 5 Zmxy Package

dev-master 2017-09-01 07:14 UTC

MIT

• lusong

README

芝麻信用是支付宝根据用户信息返回风控风险以及用户信用评分，主要用于：P2P网贷,租车,共享经济信用评分,旅行或者酒店类等中，芝麻信用接口比较多，如果自己单独去开发，会浪费一定的时间，所以我集成了Laravel芝麻信用拓展，方便大家学习管理，如果由任何疑问，欢迎

开发前的准备

1. 安装Laravel
2. 申请通过芝麻商家
3. 创建一个应用并且获取基本配置信息，详细流程开始接入

安装拓展

1.在 composer.json 的 require 里面加入以下内容：

composer require "earnp/zmxy:dev-master"

2.等待下载安装完成，需要在config/app.php中注册服务提供者同时注册下相应门面：

'providers' => [
    //........
    Earnp\Zmxy\ZmxyServiceprovider::class,
],

'aliases' => [
    //..........
    'Zmxy'      => Earnp\Zmxy\Facades\Zmxy::class,
],

服务注入以后，如果要使用自定义的配置，还可以发布配置文件到config目录：

php artisan vendor:publish

使用方法

获取登陆授权链接

Zmxy::ZhimaAuthInfoAuthorize($name,$idcard);

参数说明：

• $name为用户姓名
• $idcard为用户身份证号码

返回参数：

https://zmopenapi.zmxy.com.cn/openapi.do?app_id=1000000&channel=apppc&charset=UTF-8&method=zhima.auth.info.authorize&platform=zmop&sign=sign&version=1.0&params=params

将会返回授权链接，你将链接设置为a标签，给用户点击使用，注意：授权成功以后会返回您授权的地址，将会给你返回$sign和$params参数用于下面的获取参数

根据获取的$params换取open_id

Zmxy::getResult($params,$sign);

参数说明：

• $params为上一部中授权返回的参数
• $sign为上一部中授权返回的参数

返回参数：

[
  "open_id" => "",
  "error_message" => "操作成功",
  "state" => "您传入的身份证号码",
  "error_code" => "SUCCESS",
  "app_id" => "1004070",
  "success" => "true",
]

注意：state你可以自定义传入参数，用于判断用户，默认我返回的是用户身份证

芝麻信用评分

Zmxy::ZhimaCreditScoreGetRequest($open_id);

请求参数:

• $open_id为上一步获取到的$open_id

返回参数(对象)：

[
  "success"=>true,
  "biz_no"=>"",
  // 以后芝麻分
  "zm_score"=>"750",
]

行业关注名单

Zmxy::ZhimaCreditWatchlistiiGet($open_id);

请求参数:

• $open_id为上面授权获取到的$open_id

返回参数(对象)： 返回参数比较多，具体可以参考官方文档：https://b.zmxy.com.cn/technology/openDoc.htm?relInfo=zhima.credit.watchlistii.get@1.0@1.0

申请欺诈评分

$data = array("idcard"=>"必须","name"=>"必须","phone"=>"必须","email"=>"选填","bankcard"=>"选填:银行卡号","address"=>"选填:不要包含特殊字符","ip"=>"ip地址:选填","mac"=>"物理地址:选填","wifimac"=>"wifi的物理地址:选填","imei"=>"国际移动设备标志:选填");
// 调取接口
Zmxy::ZhimaCreditAntifraudScoreGet($data);

请求参数：

• $data,包含查询用户基本信息，无需授权，姓名身份证必须准确，更多描述查看芝麻信用

返回参数(对象)：

[
  "success"=>true,
  "biz_no"=> "",
  "score"=>88,
]

score 为信用评分，分值越高，欺诈越小

欺诈信息验证

$data = array("idcard"=>"必须","name"=>"必须","phone"=>"必须","email"=>"选填","bankcard"=>"选填:银行卡号","address"=>"选填:不要包含特殊字符","ip"=>"ip地址:选填","mac"=>"物理地址:选填","wifimac"=>"wifi的物理地址:选填","imei"=>"国际移动设备标志:选填");
// 调取接口
Zmxy::ZhimaCreditAntifraudVerify($data);

请求参数：

• $data,包含查询用户基本信息，无需授权，姓名身份证必须准确，更多描述查看芝麻信用

返回参数（对象）：

[
  "success"=>true,
  "biz_no"=> "",
  "verify_code"=> [
    0 => "V_CN_NM_MA",
    1 => "V_PH_CN_MA_UL30D",
    2 => "V_EM_CN_MA",
    3 => "V_AD_CN_MA_UL180D",
    4 => "V_AD_CN_MA_HOME",
  ]
]

verify_code中的参数说明如下： 在config/zmxy.php中

欺诈关注清单

$data = array("idcard"=>"必须","name"=>"必须","phone"=>"必须","email"=>"选填","bankcard"=>"选填:银行卡号","address"=>"选填:不要包含特殊字符","ip"=>"ip地址:选填","mac"=>"物理地址:选填","wifimac"=>"wifi的物理地址:选填","imei"=>"国际移动设备标志:选填");
// 调取接口
Zmxy::ZhimaCreditAntifraudRiskList($data);

参数说明：

• 如上所说

返回参数：

[
  "success"=>true,
  "biz_no"=>"",
  "hit"=>"yes",
  "risk_code"=>[
    0 => "R_CN_JJ_02",
    1 => "R_CN_JJ_03",
    2 => "R_PH_006",
    3 => "R_PH_JJ_02",
    4 => "R_PH_JJ_03",
  ]
]

verify_code代表风险级别，其中的参数说明如下： 在config/zmxy.php中

芝麻认证

1、芝麻认证初始化

Zmxy::ZhimaCustomerCertificationInitialize("name","idcard");

请求参数：

• name代表用户姓名
• idcard代表身份证号码 返回参数：

{
  "success"=>true,
  "biz_no"=>"ZM2017123123123123100500333662",
}

2、芝麻认证开始认证

Zmxy::ZhimaCustomerCertificationCertify($biz_no,$returnurl);

请求参数：

• biz_no为上一部中获取到的biz_no
• returnurl代表验证后转到的网址，可在下一步中获取参数 返回参数：

https://zmopenapi.zmxy.com.cn/openapi.do?app_id=1004070&channel=apppc&charset=UTF-8&method=zhima.customer.certification.certify&platform=zmop&sign=2&version=1.0&params=2

将会返回授权链接，你将链接设置为a标签，给用户点击使用，注意：授权成功以后会返回您授权的地址，将会给你返回$sign和$params参数用于下面的获取参数

3、根据获取的$params解密验签

Zmxy::getResult($params,$sign);

本步也为第二步认证后返回结果，解密获取到基本参数,到这里可以存储，后期长期使用查询

参数说明：

• $params为上一部中授权返回的参数
• $sign为上一部中授权返回的参数

返回参数：

[
  "passed" => "true",
  "biz_no" => "ZM201708023000000123400501230048",
]

4、芝麻认证查询

Zmxy::ZhimaCustomerCertificationQuery($biz_no);

请求参数：

• biz_no为上一部中验证后解密验签获取到的biz_no

返回参数：参数说明

{
  "success"=>true
  "channel_statuses"=>"[{"name"=>"FACE","status"=>"PASS"}]"
  "identity_info"=>"{"cert_name"=>"姓名","cert_no"=>"身份证","cert_type"=>"IDENTITY_CARD"}"
  "passed"=>"true"
}

好的，到这里全部接口完毕，注意：open_id，biz_no可以长期使用，做好留存，除非用户取消授权或者重新授权；后期会持续迭代，欢迎讨论以及给星！