实名认证接口开发

位置

实名认证接口放在 public/plugins/certification/ 目录下

目录结构

以官方实名认证为例，其主要目录结构如下：

public/plugins/certification/idcsmartali/
|--- controller (外部调用)
|--- Idcsmartali.php (入口文件)
|--- config.php (配置项客户配置项，在插件设置中显示)

开发流程

以官方实名认证为例:

创建实名认证目录 public/plugins/certification/idcsmartali/

①目录名以小写字母+下划线形式，必须以字母开头，如idcsmartali；

创建入口文件：Idcsmartali.php

①命名空间namespace certification\idcsmartali(控制器下命名空间对应相应目录即可,其它同理);

②以目录名大驼峰 + .php，创建在实名认证接口根目录下，如 idcsmartali/Idcsmartali.php；

③文件中需要定义info属性，示例：

# 基础信息
public $info = array(
    'name'        => 'Idcsmartali',//Demo插件英文名，改成你的插件英文就行了
    'title'       => '智简魔方-芝麻信用',
    'description' => '智简魔方-芝麻信用',
    'status'      => 1,
    'author'      => '智简魔方',
    'version'     => '1.0.0',
    'help_url'    => 'https://my.idcsmart.com/goods.html?id=817'
);

④必须实现install()安装以及uninstall()卸载方法，没有额外操作，返回true即可；

⑤可选择实现IdcsmartaliCollectionInfo($type)方法，前台自定义字段输出。

方法名：插件名+CollectionInfo

参数

参数	类型	必填	说明
`type`	`string`	—	实名认证类型，如person或company

返回值

字段	类型	说明
`返回值`	`object`	以自定义字段名为键的配置对象
`<字段>.title`	`string`	字段显示名称
`<字段>.type`	`string`	字段类型，如 text、password
`<字段>.value`	`mixed`	默认值
`<字段>.tip`	`string`	提示信息
`<字段>.required`	`boolean`	是否必填

返回：[
    'name' => [
        'title' => '姓名',
        'type'  => 'text',
        'value' => '',
        'tip'   => '',
        'required'   => true, # 是否必填
    ],
    'card' => [
        'title' => '身份证号码',
        'type'  => 'text',
        'value' => '',
        'tip'   => '',
        'required'   => true, # 是否必填
    ],
];

⑥可选择实现IdcsmartaliPerson方法，个人实名认证。

方法名：插件名+Person

参数

参数	类型	必填	说明
`card_type`	`integer`	—	证件类型:1身份证、2港澳通行证、3台湾通行证、4港澳居住证、5台湾居住证、6海外护照、7中国以外驾照、8其他
`name`	`string`	—	姓名
`card`	`string`	—	身份证号

返回值

字段	类型	说明
`返回值`	`HTML`	HTML 内容

⑦可选择实现IdcsmartaliCompany方法，企业实名认证。

方法名：插件名+Company

参数

参数	类型	必填	说明
`card_type`	`integer`	—	证件类型:1身份证、2港澳通行证、3台湾通行证、4港澳居住证、5台湾居住证、6海外护照、7中国以外驾照、8其他
`name`	`string`	—	姓名
`card`	`string`	—	身份证号

返回值

字段	类型	说明
`返回值`	`HTML`	HTML 内容

需要外部访问，在根目录下创建controller目录，添加控制器，处理异步或同步回调

到后台实名认证-接口管理，可以查看接口列表，安装、配置即可使用

示例

参考官方实名认证idcsmartali

本页目录