资源中心行业关注名单2.0版
您可以点击纯净版进行查看

开始接入

欢迎你成为芝麻信用的商户,在开始接口调用之前请先确保完成以下事项:

  1. 完成 商户入驻 流程,并已经完成本 产品签约
  2. 你需要获取一个 应用 ID,并完成必要的开发 环境配置
  3. 芝麻开放平台通过 HTTPS 通信进行接口调用,包含系统调用和页面转跳两类接口,相关概念参照 接口调用;参数的加密解密和加签验签参考 介绍文档
  4. 业务流水凭证(transaction_id)是商户与芝麻信用系统产生业务交互的唯一凭证,生成规则参考 业务流水凭证
  5. 部分芝麻信用产品需要商户进行数据反馈,参考文档 数据反馈 部分;
  6. 入参中包含 open_id 的产品需要进行授权,个人用户参照 用户授权,企业征信产品参照 企业协议授权
  7. 芝麻开放平台提供了 Java 1.5、Java 1.4 、PHP 和 .NET 的服务端 SDK 供商家快速接入服务使用,SDK 能够在 开发工具包下载页 获取。

接口信息

API 名称 zhima.credit.watchlistii.get
API 中文名称 行业关注名单2.0版
API 描述信息 行业关注名单2.0版

请求参数

系统参数:

参数名

类型

是否必须

是否芝麻分配

示例值

备注

app_id

String

1000033

商户技术开发自助创建的应用标识

charset

String

UTF-8

加密加签时使用的charset

method

String

zhima.credit.watchlistii.get

要调用的接口名

version

String

1.0

接口版本,目前只支持1.0

platform

String

zmop

来源平台,默认为zmop

params

String

加密后信息

RSA加密后的业务参数

sign

String

加密后信息

对params参数加密前的签名,算法为SHA1WithRSA


业务参数:

注:入参中的产品码(product_code)直接使用当前表格中的示例值即可

名称 类型 是否必须 描述 示例值
product_code String 产品码 w1010100100000000022
transaction_id String transaction_id是代表一笔请求的唯一标志,该标识作为对账的关键信息,对于用户使用相同transaction_id的查询,芝麻在一天(86400秒)内返回首次查询数据,超过有效期的查询即为无效并返回异常(错误码xxxx),有效期内的重复查询不重新计费。 transaction_id 推荐生成方式是:30位,(其中17位时间值(精确到毫秒):yyyyMMddHHmmssSSS)加上(13位自增数字:1234567890123) 20160101175625659000000000001
open_id String 芝麻会员在商户端的身份标识 268810000007909449496

响应参数

名称 类型 是否列表 描述
is_matched Boolean true=命中 在关注名单中 false=未命中
details ZmWatchListDetail 行业关注名单信息列表,由芝麻信用进行维护和升级
biz_no String 芝麻信用对于每一次请求返回的业务号。后续可以通过此业务号进行对账

行业关注名单详细(ZmWatchListDetail)信息详情:

名称 类型 是否列表 描述
biz_code String 风险信息行业编码
level Number 风险等级
type String 行业名单风险类型
code String 风险编码
refresh_time Date 数据刷新时间
settlement Boolean 结清状态
status String 用户本人对该条负面记录有异议时,表示该异议处理流程的状态
statement String 当用户进行异议处理,并核查完毕之后,仍有异议时,给出的声明
extend_info ZmWatchListExtendInfo 扩展信息

扩展信息(ZmWatchListExtendInfo)信息详情:

名称 类型 是否列表 描述
key String 补充信息字段的英文编码
value String 补充信息字段的信息内容
description String 补充信息字段的中文描述

请求示例

JDK 1.4 JDK 1.5 PHP .NET Python


import com.antgroup.zmxy.openplatform.api.DefaultZhimaClient;
import com.antgroup.zmxy.openplatform.api.FileItem;
import com.antgroup.zmxy.openplatform.api.ZhimaApiException;
import com.antgroup.zmxy.openplatform.api.request.ZhimaCreditWatchlistiiGetRequest;
import com.antgroup.zmxy.openplatform.api.response.ZhimaCreditWatchlistiiGetResponse;

public class TestZhimaCreditWatchlistiiGet {
    //芝麻开放平台地址
    private String gatewayUrl     = "https://zmopenapi.zmxy.com.cn/openapi.do";
    //商户应用 Id
    private String appId          = "***";
    //商户 RSA 私钥
    private String privateKey     = "***";
    //芝麻 RSA 公钥
    private String zhimaPublicKey = "***";

    public void  testZhimaCreditWatchlistiiGet() {
        ZhimaCreditWatchlistiiGetRequest req = new ZhimaCreditWatchlistiiGetRequest();
        req.setChannel("apppc");
        req.setPlatform("zmop");
        req.setProductCode("w1010100100000000022");// 必要参数 
        req.setTransactionId("20160101175625659000000000001");// 必要参数 
        req.setOpenId("268810000007909449496");// 必要参数 
        DefaultZhimaClient client = new DefaultZhimaClient(gatewayUrl, appId, privateKey, zhimaPublicKey);
        try {
            ZhimaCreditWatchlistiiGetResponse response =(ZhimaCreditWatchlistiiGetResponse)client.execute(req);
            System.out.println(response.isSuccess());
            System.out.println(response.getErrorCode());
            System.out.println(response.getErrorMessage());
        } catch (ZhimaApiException e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        TestZhimaCreditWatchlistiiGet result = new  TestZhimaCreditWatchlistiiGet();
        result.testZhimaCreditWatchlistiiGet();
    }
}

响应示例

正确示例 1 正确示例 2 正确示例 3


{
  "bizNo": "ZM201607221021223895700042091111",
  "body": "{\"details\":[{\"refresh_time\":\"2016-06-10 00:00:00\",\"biz_code\":\"AH\",\"level\":0,\"extend_info\":[{\"description\":\"编号\",\"value\":\"testlwztestlwz0d090d794bd563ba6053244b35fb2ccc\",\"key\":\"id\"},{\"description\":\"欠费停机时间\",\"value\":\"2016-01\",\"key\":\"event_end_time_desc\"}],\"settlement\":true,\"code\":\"AH001002\",\"type\":\"AH001\"}],\"is_matched\":true,\"biz_no\":\"ZM201607221021223895700042091111\",\"success\":true}",
  "details": [{
    "bizCode": "AH",
    "code": "AH001002",
    "extendInfo": [{
      "description": "编号",
      "key": "id",
      "value": "testlwztestlwz0d090d794bd563ba6053244b35fb2ccc"
    }, {
      "description": "欠费停机时间",
      "key": "event_end_time_desc",
      "value": "2016-01"
    }],
    "level": 0,
    "refreshTime": 1465488000000,
    "settlement": true,
    "type": "AH001"
  }],
  "isMatched": true,
  "params": {
    "params": "XvEG7vg0WSVBh+Ht9YDgnHMjxYaIIovF9+l/Uj0VlW7Yb2p0iA4vDVtt+sstJx7rt0BexL4l01BJ5+5/FAM69gvpQV/qcb8Hyp6d/ZYCvt5/vmM0eAhTVl6IeGNuujLzeGv+o3yl0KbusZI+QgmWfvlPP5Oci+URMA9YdQ72gdY="
  },
  "success": true
}

异常示例

错误示例 1 错误示例 2 错误示例 3


{
  "body": "{\"success\":false,\"error_code\":\"ZMOP.invalid_platform_param\",\"error_message\":\"无效的platform参数\"}",
  "errorCode": "ZMOP.invalid_platform_param",
  "errorMessage": "无效的platform参数",
  "params": {
    "params": "GdvPV+rExv/OlJyX8MQE1BY37pIZbQrGU4xFJzv2exdc+KZgEUYNdd3Po+mEpdP137zp/TzXLSKCZFJKgPeRUxna20qyxP7JVgNh8wot0uqVhF5RwQ8VizmsCuY1pJ4eJUOZG6AvVGXrh5876DwXJZORu0OmeRJQCEwGoEuTupI="
  },
  "success": false
}

错误码说明

接口错误码
名称 错误描述 解决方案
ZMCREDIT.api_product_not_match 输入的产品码不正确 请传入正确的产品码
ZMCREDIT.authentication_fail 鉴权失败 请客户给商户授权
ZMCREDIT.invalid_transaction_id 业务流水号不正确 传入正确的transaction_id字段
ZMCREDIT.no_valid_arrangement 无有效合约 完成产品签约
ZMCREDIT.openid_parameter_invalid open_id参数错误 请传入正确的open_id
ZMCREDIT.parameter_invalid 参数错误 请检查输入参数
ZMCREDIT.product_code_is_null 产品码为空 请输入产品码
ZMCREDIT.system_error 系统错误 重试或反馈芝麻信用技术支持
ZMCREDIT.transaction_id_expired 业务流水号已过期 请传入正确的业务流水号
ZMCREDIT.transaction_id_repeat 相同业务流水号但业务参数不一致,请求被拒绝。 每个请求请生成唯一的业务流水号transaction_id

系统错误码
名称 错误描述 解决方案
ZMOP.isv_cannot_invoke_method 平台服务商自营模式下不能调用该接口 平台服务商自营模式下不能调用该接口
ZMOP.not_isv_invoke_method 非平台类商户不能调用该接口 非平台类商户不能调用该接口
ZMOP.private_api_invoke_error 私有接口不能调用 芝麻开放平台不能调用私有接口
ZMOP.linked_merchant_relation_error 二级商户的关联关系错误 该二级商户不属于平台服务商
ZMOP.linked_merchant_zhima_freezed 二级商户被芝麻冻结 请联系芝麻客服,解冻该二级商户
ZMOP.linked_merchant_not_zhima_certificated 二级商户未通过芝麻认证 二级商户必须通过芝麻认证
ZMOP.linked_merchantid_not_certificated 二级商户未认证 二级商户必须通过认证
ZMOP.linked_merchant_is_null 二级商户不存在 请先确认二级商户是否存在
ZMOP.aop_platform_merchant_not_isv AOP渠道调用的平台服务商必须是非ISV模式 AOP渠道调用的平台服务商必须是非ISV模式
ZMOP.linked_merchantid_is_null 二级商户标识为空 平台服务商调用时,二级商户标识必须存在
ZMOP.linked_merchant_is_not_null 非平台类商户的二级商户必须为空 非平台类商户的二级商户必须为空
ZMOP.invalid_merchantid_param 无效的商户标识 请确认商户标识
ZMOP.app_invoke_excess_limit app接口调用受限 测试应用在使用中只能对特定配置的接口进行调用
ZMOP.missing_authtemplate_param 缺少授权模板参数 请确保已经创建了对应的授权模式
ZMOP.app_invoke_excess_limitation 应用调用服务次数超限 请降低应用调用的qps
ZMOP.invoke_isp_error 调用服务接口错误 芝麻内部服务出现错误,请稍后再试
ZMOP.invalid_openid_param 无效的open_id参数 请使用授权成功返回的open_id查询授权类信用产品.
ZMOP.cache_page_param_error 缓存签名参数错误 芝麻内部服务出现错误,请稍后再试
ZMOP.sign_system_param_error 用芝麻私钥加签返回结果错误 芝麻内部服务出现错误,请稍后再试
ZMOP.sign_page_param_error 用芝麻私钥加签页面参数错误 芝麻内部服务出现错误,请稍后再试
ZMOP.verify_sign_app_public_key_error 用商户公钥验签错误 请使用商户私钥加签
ZMOP.decode_private_key_error 用芝麻私钥解密错误 请使用芝麻公钥对数据加密
ZMOP.missing_interfaceconfig 缺少对应的接口配置信息 请确保接口名称和版本信息是否正确
ZMOP.missing_version_param 缺少version参数 请输入接口版本参数
ZMOP.missing_method_param 缺少method参数 请输入接口方法参数
ZMOP.invalid_charset_param 无效charset参数 请验证编码是否正确
ZMOP.missing_charset_param 缺少charset参数 请输入数据传输的编码
ZMOP.invalid_scene_param 无效的scene参数 请验证场景参数是否正确
ZMOP.missing_scene_param 缺少scene参数 请输入场景参数
ZMOP.missing_sign_param 缺少sign参数 请验证签名参数正确
ZMOP.missing_params_param 缺少params参数 请验证请求参数是否正确
ZMOP.invalid_channel_param 无效的channel参数 请验证请求方式是否正确
ZMOP.invalid_platform_param 无效的platform参数 请验证platform参数是否正确
ZMOP.invalid_app_status 应用生命周期状态错误 应用的状态必须是上线
ZMOP.invalid_appruntime_state 应用运行状态错误 应用的运行状态必须是正常
ZMOP.invalid_platform_appid_param 无效的渠道商app_id参数 请校验渠道商app_id是否正确
ZMOP.missing_platform_appid_param 缺少渠道商的app_id参数 请输入渠道商的app_id
ZMOP.unknow_error 未知错误 重试
ZMOP.invalid_appid_param 无效的app_id参数 传入正确的app_id
ZMOP.missing_appid_param 缺少app_id参数 传入app_id参数
  1. 开始接入
  2. 接口信息
  3. 请求参数
  4. 响应参数
  5. 请求示例
  6. 响应示例
  7. 异常示例
  8. 错误码说明
onlineServer