/qn-api

清宁云服sdk

Primary LanguagePHP

qn-api SDK

清宁云服api接口SDK

安装

$ composer require ashin33/qn-api -vvv

请求可用方法

方法名称 中文名称 说明
request 发送请求 加密请求参数并请求清宁云服,并解密返回参数
decrypt 解密返回 解密清宁云服返回参数,同样适用于异步回调的解密
register ⾃由职业者注册 单人注册
batchRegister ⾃由职业者批量注册 多人批量注册注册
batchRegisterQuery ⾃由职业者批量注册查询 多人批量注册查询
idCardUpload 个⼈身份证上传 url格式上传身份证附件
idCardFileUpload 个⼈身份证上传<表单文件> 表单格式上传身份证附件
createTask 新建任务需求 新建任务需求
taskList 任务需求查询 查询已建立的任务需求
invoiceCategoryList 发票类目查询 税源地可用开票类目查询
taxSourceList 税源地查询 可用税源地及打款信息查询
settlement 上传结算单 批量结算
settlementQuery 结算查询 按批次查询接口结果
settlementSingleQuery 结算单笔查询 按商户流水号查询单笔结算
balanceQuery 余额查询 商户余额查询
rechargeList 充值流水查询 商户充值流水查询
settlementList 结算流水查询 历史结算明细查询
invoiceApply 开票申请 开票申请
invoiceQuery 开票申请查询 开票申请结果查询
merchantApply 商户进件 使用当前商户,推荐其他商户进件
merchantQuery 商户进件查询 查询进件结果
merchantSign 发送企业签约短信 发送当前企业与税源地的签约短信,部分税源地不支持
merchantSignQuery 签约查询 企业与税源地的签约查询

响应可用方法

方法名称 中文名称 说明
isSuccess 判断响应是否成功 接收响应后,根据响应码判断接口请求是否成功
isFail 判断响应是否失败 接收响应后,根据响应码判断接口请求是否失败
getReason 获取接口响应失败原因 响应失败后,使用该方法获取失败原因
toJsonString 响应格式化为json 接收响应后,可将响应报文转化为json格式的字符串

用法示例

具体使用请参考 调用示例,支持使用request方法发起SDK中未定义的接口请求

$host = '清宁云服分配的实际请求域名';
$qnPublicKey = '***.key';//清波公钥(文件路径或行内秘钥字符串)
$merchantPrivateKey = '***.key';//商户私钥(文件路径或行内秘钥字符串)
$instId = '********';//清波分配的商户id
$secret = '*************************';//清波分配的秘钥
$api = new Ashin33\QnApi\QnApi(
    $instId, 
    $secret,
    $qnPublicKey,
    $merchantPrivateKey,
    $host
);

$data = [
    "customer_name" => "安*",
    "cert_no" => "1301****7389",
    "customer_mobile" => "156****6907",
    "bank_card_no" => "6215****4390",
    "bank_phone" => "156****6907"
];
$res = $api->register($data);
var_dump($res->isSuccess());//判断接口请求是否成功

在laravel中使用

发布配置文件

执行 php artisan vendor:publish --tag=qn-api 命令,在configs目录下生成qn-api.php文件,按需修改参数

使用

use Ashin33\QnApi\Facades\QnApi;

$data = [
    "customer_name" => "安*",
    "cert_no" => "1301****7389",
    "customer_mobile" => "156****6907",
    "bank_card_no" => "6215****4390",
    "bank_phone" => "156****6907"
];
$res = QnApi::register($data);
var_dump($res->isSuccess());

更新扩展包

$ composer update ashin33/qn-api

贡献

您可以通过以下三种方式之一做出贡献:

  1. 使用 issue tracker 上报bug.
  2. issue tracker 中回复问题或bug.
  3. 贡献新功能或更新 wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.

证书

MIT