开发者中心 · API v1
ChemBuyGuide API 文档
使用版本化的 OpenAPI 规范接入公开产品、供应商与化学工具。测试环境和正式环境使用独立网关地址,数据与调用风险不混用。
OPENAPI3.1- API
- v1.0.0
- FORMAT
- JSON
- ENCODING
- UTF-8
测试环境用于联调和验证,使用隔离的测试数据与配额。
基础地址—
API 文档环境尚未配置完整。请分别设置测试和正式网关地址,且两者不能相同。
参数
| Name | In | Type | 说明 |
|---|
timezone可选 | query | string | 访客的 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"
}
}
参数
| Name | In | Type | 说明 |
|---|
q必填 | query | string | CAS、产品名称或搜索关键词。 |
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"
}
]
}
参数
| Name | In | Type | 说明 |
|---|
id必填 | path | string | 产品数字 ID、产品编码或公开 slug。 |
page可选 | query | integer | 关联供应商页码,最大 25。 |
per_page可选 | query | integer | 每页供应商数量,最大 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
}
}
}
}
参数
| Name | In | Type | 说明 |
|---|
alphabet必填 | path | string | A-Z 的单个英文字母。 |
offset必填 | path | integer | 记录偏移量,使用 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
}
}
}
参数
| Name | In | Type | 说明 |
|---|
slug必填 | path | string | 供应商公开 slug。 |
page可选 | query | integer | 关联产品页码,最大 25。 |
per_page可选 | query | integer | 每页产品数量,最大 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
}
}
}
}
请求体
{
"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 可以进入在线测试白名单。