颜鹭网络 Open API
颜鹭网络提供标准化 RESTful API,帮助合作方快速接入域名查询、服务商数据与消息通讯能力。所有请求需通过 HTTPS 发起。
Base URL:https://api.vokabk.cn/v1
Content-Type: application/json | 编码:UTF-8
鉴权说明
所有 API 请求需在 HTTP Header 中携带 Authorization 字段,格式如下:
Authorization: Bearer YOUR_API_KEY
API Key 可在商户后台「开发者中心」中申请。如无账号,请先 申请入驻。
域名查询
GET
/domain/check
查询域名是否可注册
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| domain | string | 是 | 要查询的域名,如 example.com |
响应示例
{
"code": 0,
"msg": "success",
"data": {
"domain": "example.com",
"available": true,
"price": 65.00,
"currency": "CNY"
}
}
域名价格
GET
/domain/price
获取域名后缀价格列表
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| tld | string | 否 | 后缀,如 com / cn,不传则返回所有 |
响应示例
{
"code": 0,
"data": [
{ "tld": "com", "register": 65.00, "renew": 68.00 },
{ "tld": "cn", "register": 29.00, "renew": 35.00 },
{ "tld": "net", "register": 72.00, "renew": 75.00 }
]
}
服务商列表
GET
/merchants
获取平台入驻服务商列表
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | string | 否 | 服务类型筛选:register / trade / broker |
| page | int | 否 | 页码,默认 1 |
| size | int | 否 | 每页数量,默认 20,最大 50 |
响应示例
{
"code": 0,
"data": {
"total": 2,
"list": [
{ "id": "xq001", "name": "祥勤域名", "rating": 4.9, "services": ["register","trade","broker"] },
{ "id": "bb001", "name": "比一比域名", "rating": 4.8, "services": ["trade","auction","broker"] }
]
}
}
消息推送
POST
/message/push
向指定用户推送通知消息
请求 Body
{
"to": "user_id_or_phone",
"type": "sms", // sms | email | webhook
"content": "您的域名 example.com 即将到期,请及时续费",
"extra": {}
}
响应示例
{
"code": 0,
"msg": "success",
"data": { "msg_id": "msg_20260506_abc123" }
}
错误码说明
| 错误码 | 说明 | 处理建议 |
|---|---|---|
| 0 | 成功 | 正常处理返回数据 |
| 401 | 未授权 / API Key 无效 | 检查 Authorization Header |
| 403 | 权限不足 | 联系平台开通对应权限 |
| 429 | 请求频率超限 | 降低调用频率,默认 100次/分钟 |
| 500 | 服务器内部错误 | 稍后重试或联系技术支持 |
技术支持邮箱:contact@vokabk.cn