allinssl/frontend/apps/domain-management-backend/doc/api.json

1090 lines
19 KiB
JSON

{
"apis": [
{
"name": "获取概览数据",
"path": "/api/v1/domain/manage/dashboard_overview",
"method": "POST",
"request": {
"body": {}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {
"domain_status_top": [],
"expiring_domains": 0,
"pending_orders": 0,
"recent_orders": [],
"total_domains": 0
},
"msg": "用户后台首页统计获取成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "获取域名列表",
"path": "/api/v1/domain/manage/list",
"method": "POST",
"request": {
"body": {}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {
"data": [
{
"created_at": 1754358178,
"dns_id": 0,
"expire_time": 1755269100,
"full_domain": "wzznnnnnb.top",
"id": 1,
"ns1": null,
"ns2": null,
"ns_status": 0,
"real_name_status": 0,
"real_name_template_id": 5,
"register_time": 1754577905,
"remark": "一个很牛逼的域名",
"status": 1,
"suffix": "top"
}
],
"page": "<div><span class='Pcurrent'>1</span><span class='Pcount'>共1条数据</span></div>",
"row": "10",
"shift": "0"
},
"msg": "域名列表获取成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "获取指定域名详情",
"path": "/api/v1/domain/manage/detail",
"method": "POST",
"request": {
"body": {
"domain_id": 1
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {
"dns_records": [
{
"MX": 55,
"TTL": 600,
"created_at": 1754447506,
"domainID": 195631306,
"domain_id": 1,
"record": "cc",
"recordID": 607981664,
"record_id": 2,
"remark": "",
"state": 0,
"type": "CNAME",
"uid": 1111,
"value": "dns.bt.cn",
"viewID": 0
}
],
"domain_info": {
"created_at": 1754358178,
"dns_id": 0,
"dns_lock": 0,
"dns_state": 0,
"dns_type": 1,
"domainId": 195631306,
"domain_name": "wzznnnnnb",
"expire_time": 1755269100,
"full_domain": "wzznnnnnb.top",
"id": 1
},
"real_name_info": {
"address": "南城区天安数码城F8栋106",
"address_en": "Room 106, Unit 8, Building 6, Tian'an Cyber Park, No. 1 Huangjin Road, Nancheng Street, Dongguan City, Guangdong Province"
}
},
"msg": "域名详情获取成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "获取实名信息模板列表",
"path": "/api/v1/contact/get_user_detail",
"method": "POST",
"request": {
"body": {}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 1000,
"data": "获取成功",
"msg": {
"data": [
{
"address": "南城区天安数码城F8栋106",
"address_en": "Room 106, Unit 8, Building 6, Tian'an Cyber Park, No. 1 Huangjin Road, Nancheng Street, Dongguan City, Guangdong Province"
}
],
"page": "<div><span class='Pcurrent'>1</span><span class='Pcount'>共1条数据</span></div>",
"row": "10",
"shift": "0"
},
"status": 0
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "创建实名信息模板",
"path": "/api/v1/contact/create",
"method": "POST",
"request": {
"body": {
"uid": 10001,
"template_name": "张三个人模板",
"type": 1,
"owner_name": "张三",
"owner_name_en": "Zhang San",
"contact_person": "张三",
"city": "北京",
"address": "朝阳区XX路",
"address_en": "Chaoyang, Beijing",
"postal_code": "100000",
"phone": "13800000000",
"email": "zhangsan@example.com",
"id_type": 1,
"id_number": "110101199001011234",
"id_image_front": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"id_image_back": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"is_default": 1
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "上传身份证正面图片",
"path": "/api/v1/contact/upload_cardid_front",
"method": "POST",
"request": {
"body": {
"file": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD..."
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "上传身份证背面图片",
"path": "/api/v1/contact/upload_cardid_back",
"method": "POST",
"request": {
"body": {
"file": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD..."
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "上传营业执照图片",
"path": "/api/v1/contact/upload_business_license",
"method": "POST",
"request": {
"body": {
"file": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD..."
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "获取用户上传的图片",
"path": "/api/v1/contact/get_images_by_name",
"method": "POST",
"request": {
"body": {
"file": "f6b9e62a71b211f0be471a4b78c8f991.jpg"
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "刷新实名认证审核进度",
"path": "/api/v1/contact/detail",
"method": "POST",
"request": {
"body": {
"registrant_id": "reg123456"
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "删除实名认证模板",
"path": "/api/v1/contact/del_user_detail",
"method": "POST",
"request": {
"body": {
"registrant_id": "reg123456"
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "获取购物车列表",
"path": "/api/v1/order/cart/list",
"method": "POST",
"request": {
"body": {}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "添加购物车列表",
"path": "/api/v1/order/cart/add",
"method": "POST",
"request": {
"body": {
"domain_name": "kenpai",
"suffix": "com",
"type": 1,
"years": 1,
"domain_id": 0
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "更新购物车列表",
"path": "/api/v1/order/cart/update",
"method": "POST",
"request": {
"body": {
"cart_id": 1001,
"years": 2,
"is_selected": 1
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "移除购物车列表",
"path": "/api/v1/order/cart/remove",
"method": "POST",
"request": {
"body": {
"cart_id": 1001
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "清空购物车列表",
"path": "/api/v1/order/cart/clear",
"method": "POST",
"request": {
"body": {}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "获取用户订单",
"path": "/api/v1/domain/manage/order_overview_and_list",
"method": "POST",
"request": {
"body": {}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "创建域名DNS记录",
"path": "/api/v1/dns/domain/create",
"method": "POST",
"request": {
"body": {
"domainId": 12345
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "删除域名/关闭内置DNS",
"path": "/api/v1/dns/domain/delete",
"method": "POST",
"request": {
"body": {
"domainId": 12345
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "查找域名信息",
"path": "/api/v1/dns/domain/find",
"method": "POST",
"request": {
"body": {
"domainId": 12345
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "锁定域名",
"path": "/api/v1/dns/domain/lock",
"method": "POST",
"request": {
"body": {
"domainId": 12345
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "解锁域名",
"path": "/api/v1/dns/domain/unlock",
"method": "POST",
"request": {
"body": {
"domainId": 12345
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "暂停域名",
"path": "/api/v1/dns/domain/pause",
"method": "POST",
"request": {
"body": {
"domainId": 12345
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "启用域名",
"path": "/api/v1/dns/domain/enable",
"method": "POST",
"request": {
"body": {
"domainId": 12345
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "获取DNS记录列表",
"path": "/api/v1/dns/record/list",
"method": "POST",
"request": {
"body": {
"domainId": 12345
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "添加DNS记录",
"path": "/api/v1/dns/record/create",
"method": "POST",
"request": {
"body": {
"domainId": 12345,
"record": "www",
"type": "A",
"value": "192.168.1.1",
"TTL": 600,
"MX": 10
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "修改DNS记录",
"path": "/api/v1/dns/record/update",
"method": "POST",
"request": {
"body": {
"domainId": 12345,
"recordId": 6789,
"record": "www",
"type": "A",
"value": "192.168.1.2",
"TTL": 300,
"MX": 10
}
},
"response": {
"success": {
"code": 200,
"data": {
"code": 0,
"data": {},
"msg": "操作成功",
"status": true
}
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "删除DNS记录",
"path": "/api/v1/dns/record/delete",
"method": "POST",
"request": {
"body": {
"domainId": 12345,
"recordId": 6789
}
},
"response": {
"success": {
"code": 200,
"message": "暂无数据"
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "获取域名价格列表",
"path": "/api/v1/domain/price/list",
"method": "POST",
"request": {
"body": {}
},
"response": {
"success": {
"code": 200,
"message": "暂无数据"
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "查询域名是否可注册",
"path": "/api/v1/domain/check",
"method": "POST",
"request": {
"body": {
"domain_name": "example",
"suffix": "com"
}
},
"response": {
"success": {
"code": 200,
"message": "暂无数据"
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "注册域名",
"path": "/api/v1/domain/register",
"method": "POST",
"request": {
"body": {
"domain_name": "example",
"suffix": "com",
"years": 1,
"template_id": 123
}
},
"response": {
"success": {
"code": 200,
"message": "暂无数据"
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "域名续费",
"path": "/api/v1/domain/renew",
"method": "POST",
"request": {
"body": {
"domain_id": 12345,
"years": 1
}
},
"response": {
"success": {
"code": 200,
"message": "暂无数据"
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "域名转入",
"path": "/api/v1/domain/transfer_in",
"method": "POST",
"request": {
"body": {
"domain_name": "example.com",
"auth_code": "ABC123",
"years": 1
}
},
"response": {
"success": {
"code": 200,
"message": "暂无数据"
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
},
{
"name": "域名转出",
"path": "/api/v1/domain/transfer_out",
"method": "POST",
"request": {
"body": {
"domain_id": 12345
}
},
"response": {
"success": {
"code": 200,
"message": "暂无数据"
},
"error": {
"code": 404,
"data": {
"code": -1,
"data": null,
"msg": "请求失败",
"status": false
}
}
}
}
]
}