跳转到内容

获取产品信息接口

合作商可通过 API 密钥查询当前系统中可售产品信息,并按域名类型、品牌代码、验证类型、产品名称、产品代码进行筛选。

请求信息

项目说明
请求地址/partner/GetUserProduct/
请求方式POST
Content-Typeapplication/jsonapplication/x-www-form-urlencoded

请求参数

参数类型必填说明
apikeystringAPI 密钥。推荐传 app_id:api_secret,也兼容仅传 api_secret
domain_typestring域名类型,支持传类型代码或名称,如 singlewildcard单域名
brand_codestring品牌代码,如 digicertcertumcnssl
verification_typestring验证类型,支持传验证代码或名称,如 dvovev域名验证
product_namestring产品名称,支持模糊查询。
product_codestring产品代码,精确匹配。
pageinteger页码,默认 1。仅在传入 limit 时用于分页。
limitinteger每页数量。未传或为空时返回全部匹配产品;传入时最大 500

请求示例

json
{
  "apikey": "ak_xxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

响应参数

参数类型说明
codeinteger业务状态码,200 表示成功。
messagestring响应消息。
data.totalinteger符合条件的产品总数。
data.pageinteger当前页码。
data.limitinteger本次返回数量限制。未传 limit 时等于全部匹配产品数量。
data.total_pagesinteger总页数。
data.itemsarray产品列表。

产品字段

参数类型说明
product_namestring产品名称。
product_codestring产品代码。
product_typestring产品类型名称,如 SSL 证书。
product_type_codestring产品类型代码,如 ssl
verification_typestring验证类型名称。
verification_type_codestring验证类型代码,如 dvovev
domain_typestring域名类型名称。
domain_type_codestring域名类型代码。
brandstring品牌名称。
brand_codestring品牌代码。
signature_algorithmsarray支持的签名算法及对应加密强度。
hash_algorithmsarray支持的哈希算法。
verification_methodsarray产品支持的证书验证方式。未配置限制时返回系统全部启用验证方式。
valid_yearsarray可选年限及对应价格。
base_pricenumber当前用户的一年期基础价格。
san_pricenumber额外单域名单价。
wildcard_pricenumber额外通配符单价。
max_single_domainsinteger最大单域名数量。
max_domainsinteger最大域名数量,同 max_single_domains
max_wildcardsinteger最大通配符数量。

签名算法字段

参数类型说明
namestring签名算法名称,如 RSAECC
codestring签名算法代码。
categorystring算法分类。
descriptionstring/null算法说明。
encryption_strengthsarray当前签名算法支持的加密强度。

年限价格字段

参数类型说明
yearsnumber年限。
monthsinteger月数。
pricenumber对应价格。用户有专属时长价格时返回专属价格。
san_pricenumber该年限对应的额外单域名单价。
wildcard_pricenumber该年限对应的额外通配符单价。

验证方式字段

参数类型说明
idinteger/null验证方式 ID。
namestring验证方式名称。
codestring验证方式代码,如 dnsfileemail-admindcv
typestring/null验证方式类型:dnsfileemaildcv
descriptionstring/null验证方式说明。

响应示例

json
{
  "code": 200,
  "message": "ok",
  "data": {
    "total": 1,
    "page": 1,
    "limit": 1,
    "total_pages": 1,
    "items": [
      {
        "product_name": "CNSSL DV SSL",
        "product_code": "cnssl-dv",
        "product_type": "SSL 证书",
        "product_type_code": "ssl",
        "verification_type": "域名验证",
        "verification_type_code": "dv",
        "brand": "CNSSL",
        "brand_code": "cnssl",
        "signature_algorithms": [
          {
            "name": "RSA",
            "code": "rsa",
            "encryption_strengths": [
              { "name": "RSA-2048", "code": "rsa-2048" }
            ]
          }
        ],
        "hash_algorithms": [
          { "name": "SHA-256", "code": "sha256" }
        ],
        "verification_methods": [
          {
            "id": 1,
            "name": "DNS 验证",
            "code": "dns",
            "type": "dns",
            "description": "通过在域名 DNS 添加 TXT 记录完成域名所有权验证"
          }
        ],
        "valid_years": [
          { "years": 1, "months": 12, "price": 98 }
        ],
        "max_single_domains": 1,
        "max_wildcards": 0
      }
    ]
  }
}

错误码

code说明
400请求参数错误。
401API 密钥无效。
403API 密钥关闭、吊销、过期,IP 不在白名单内,或账号被封禁。
405请求方式错误。
500服务器错误。

EveryoneTrust SSL 文档中心,帮助你稳定完成 HTTPS 运维。