PING服务
接口说明
[!NOTE]
用于测试服务的连通性,确定服务是否可用
http请求方式
[!NOTE]
POST application/x-www-form-urlencoded
http请求地址
[!NOTE]
$SERVICE_URL/v2/ping #其中$SERVICE_URL为生产或测试的地址
http请求参数
[!NOTE]
除公共必填参数外,ping服务不需要再外传参数
代码实现
JAVA实现
//SHA3-256 必须指定加密提供商为//BouncyCastleProvider
RequestUtils requestUtils=RequestUtils.init(SERVICE_URL,APP_KEY,APP_SECRET);//建议生成为spring bean
ResultInfo<Void> ri= requestUtils.doPost("/v2/ping");
log.info("请求结果:"+ JSONObject.toJSONString(ri));
Assert.notNull(ri,"请求失败,返回结果为空。");
Assert.isTrue(ri.isSuccess(),"请求失败:"+ri.getMsg());
//{"msg":"app_secret不可用","resultCode":"HTTP_PARAM_ERROR","success":false}
//{"success":true}
PHP实现
//参考:https://gitee.com/ebaoquan/jzq_sdk_php/blob/master/example/junziqian/test/ping.php
//构建请求工具
$requestUtils=new RequestUtils($serviceUrl, $appkey, $appSecret);
//发起PING请求
$response=$requestUtils->doPost("/v2/ping");
//处理结果
printf( CommonUtil::json_encode($response));
http返回参数
[!NOTE]
返回response为application/json的数据,其字段说明如下
参数 | 类型 | 是否必返回 | 说明 |
---|---|---|---|
success | bool | * | 成功true;异常false |
msg | string | ? | 异常时,返回异常原因 |
resultCode | string | * | 异常时返回 |
[!NOTE]
返回结果,参考:
//{"msg":"app_secret不可用","resultCode":"HTTP_PARAM_ERROR","success":false}
//{"success":true}