开发者中心 · API v1

ChemBuyGuide API 文档

使用版本化的 OpenAPI 规范接入公开产品、供应商与化学工具。测试环境和正式环境使用独立网关地址,数据与调用风险不混用。

OPENAPI3.1
API
v1.0.0
FORMAT
JSON
ENCODING
UTF-8

ENVIRONMENT

选择 API 环境

测试环境

用于联调和验证,使用隔离的测试数据与配额。

基础地址—
GET/home/statisticsProducts

获取首页资料统计

统计有效、非私有的化学品资料和外部企业资料,排除停用及已删除记录。企业数量不代表已认证或已供货的供应商;国家/地区按这些企业的非空两字母国家编码去重。首页自动传入访客浏览器的 IANA 时区,各时区每天首次请求计算并缓存至当地次日零点,自动适配夏令时。updated_at 为本次统计生成的 ISO 8601 时间,首页按访客时区显示。接口保留原始计数;首页按 K+/M+/B+ 向下取整展示,国家/地区不足 10 个时隐藏。读取失败返回错误,不以零值代替缺失数据。

无需认证在线测试需登录

参数

NameInType说明
timezone可选querystring访客的 IANA 时区,例如 America/New_York 或 Asia/Shanghai。省略时默认 UTC;无效时区返回错误。

cURL 示例

# API documentation environment is not configured

在线 API 测试

请求由服务端根据白名单生成,不能自定义目标 URL、方法或请求头。

—
在线测试需登录

请先登录,再使用当前环境的在线 API 测试。

登录后测试
200 响应示例
{
  "code": 0,
  "message": "ok",
  "data": {
    "chemical_count": 120000,
    "company_count": 2400,
    "country_count": 15,
    "updated_at": "2026-09-05T06:00:00.000000Z"
  }
}
GET/home/es-searchProducts

搜索产品

按 CAS、名称或关键词检索公开产品目录。

无需认证在线测试需登录

参数

NameInType说明
q必填querystringCAS、产品名称或搜索关键词。

cURL 示例

# API documentation environment is not configured

在线 API 测试

请求由服务端根据白名单生成,不能自定义目标 URL、方法或请求头。

—
在线测试需登录

请先登录,再使用当前环境的在线 API 测试。

登录后测试
200 响应示例
{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": 1001,
      "cas": "64-17-5",
      "name": "Ethanol",
      "molecular_formula": "C2H6O",
      "url": "/products/64-17-5-ethanol-example"
    }
  ]
}
GET/v1/products/{id}Products

获取产品详情

使用产品数字 ID、产品编码或公开规范化 slug 获取产品和供应商摘要。

无需认证在线测试需登录

参数

NameInType说明
id必填pathstring产品数字 ID、产品编码或公开 slug。
page可选queryinteger关联供应商页码,最大 25。
per_page可选queryinteger每页供应商数量,最大 20。

cURL 示例

# API documentation environment is not configured

在线 API 测试

请求由服务端根据白名单生成,不能自定义目标 URL、方法或请求头。

—
在线测试需登录

请先登录,再使用当前环境的在线 API 测试。

登录后测试
200 响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "id": 1001,
    "cas": "64-17-5",
    "display_name": "Ethanol",
    "molecular_formula": "C2H6O",
    "molecular_weight": "46.07",
    "canonical_smiles": "CCO",
    "suppliers": {
      "data": [],
      "meta": {
        "current_page": 1,
        "per_page": 10
      }
    }
  }
}
GET/v1/suppliers/directory/alphabet/{alphabet}/{offset}Suppliers

按名称首字母获取供应商目录

按英文名称首字母获取公开供应商目录,每页 18 条;下一页 offset 增加 18。响应不会包含电话、邮箱或内部总量信息。

无需认证在线测试需登录

参数

NameInType说明
alphabet必填pathstringA-Z 的单个英文字母。
offset必填pathinteger记录偏移量,使用 0、18、36 等,最大 486。

cURL 示例

# API documentation environment is not configured

在线 API 测试

请求由服务端根据白名单生成,不能自定义目标 URL、方法或请求头。

—
在线测试需登录

请先登录,再使用当前环境的在线 API 测试。

登录后测试
200 响应示例
{
  "code": 0,
  "message": "ok",
  "data": {
    "data": [
      {
        "id": 1001,
        "name": "Example Chemical Supplier",
        "slug": "example-chemical-supplier",
        "country_code": "CN",
        "city": "Nanjing",
        "phone_numbers": [],
        "email_addresses": [],
        "contacts": []
      }
    ],
    "meta": {
      "current_page": 1,
      "per_page": 18,
      "has_more_pages": false
    }
  }
}
GET/v1/suppliers/{slug}Suppliers

获取供应商详情

按公开 slug 获取供应商及其产品摘要;匿名响应会移除非公开联系方式。

无需认证在线测试需登录

参数

NameInType说明
slug必填pathstring供应商公开 slug。
page可选queryinteger关联产品页码,最大 25。
per_page可选queryinteger每页产品数量,最大 20。

cURL 示例

# API documentation environment is not configured

在线 API 测试

请求由服务端根据白名单生成,不能自定义目标 URL、方法或请求头。

—
在线测试需登录

请先登录,再使用当前环境的在线 API 测试。

登录后测试
200 响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "display_name": "Example Chemical Supplier",
    "slug": "example-chemical-supplier",
    "country_code": "CN",
    "website": "https://supplier.example.com",
    "products": {
      "data": [],
      "meta": {
        "current_page": 1,
        "per_page": 10
      }
    }
  }
}
POST/structure-visualizeChemistry

生成结构预览

将 SMILES 转为 SVG 结构预览。测试环境适合联调;正式环境请求会消耗真实服务资源。

无需认证在线测试需登录

请求体

{
  "smi": "CCO",
  "software": "rdkit"
}

cURL 示例

# API documentation environment is not configured

在线 API 测试

请求由服务端根据白名单生成,不能自定义目标 URL、方法或请求头。

—
在线测试需登录

请先登录,再使用当前环境的在线 API 测试。

登录后测试
200 响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\">...</svg>",
    "contentType": "image/svg+xml; charset=utf-8"
  }
}

规范由 ci-web 源码维护;只有本页登记的 operationId 可以进入在线测试白名单。