API 文档

LinkCRM API 使用文档，通过 API 可以提交外链到系统

API 概览

使用 API Key 进行身份验证，支持浏览器插件、自动化脚本等场景

接口地址：POST /api/v1/links/submit

认证方式：

在请求头中添加 API Key，支持以下三种方式：

x-api-key: YOUR_API_KEY
Authorization: Bearer YOUR_API_KEY
?api_key=YOUR_API_KEY (Query参数)

提示： 您需要先生成 API Key 才能使用 API。

请求示例

cURL 示例

curl -X POST https://linktrx.jiahaoyg.xyz/api/v1/links/submit \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "title": "示例网站",
    "description": "这是一个示例网站的描述",
    "category": "技术平台",
    "publishType": "写文章",
    "example": ["https://example.com/article1"],
    "cost": 0.5,
    "contact_info": "contact@example.com",
    "page_authority": 50
  }'

JavaScript (Fetch) 示例

fetch('https://linktrx.jiahaoyg.xyz/api/v1/links/submit', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com',
    title: '示例网站',
    description: '这是一个示例网站的描述',
    category: '技术平台',
    publishType: '写文章',
    example: ['https://example.com/article1'],
    cost: 0.5,
    contact_info: 'contact@example.com',
    page_authority: 50
  })
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

Python 示例

import requests

url = 'https://linktrx.jiahaoyg.xyz/api/v1/links/submit'
headers = {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
}
data = {
    'url': 'https://example.com',
    'title': '示例网站',
    'description': '这是一个示例网站的描述',
    'category': '技术平台',
    'publishType': '写文章',
    'example': ['https://example.com/article1'],
    'cost': 0.5,
    'contact_info': 'contact@example.com',
    'page_authority': 50
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

请求参数

必填字段

url

外链URL，必须是完整的URL（包含协议）

title

外链标题，不能包含域名

description

外链描述，介绍如何在该外链网站上发布外链，不能包含域名

category

分类，可选值：其他平台、博客平台、应用平台、技术平台、社交平台、导航站

publishType

发布形式，可选值：写文章、写自我介绍、回评论、写贴子、发动态、回答问题、写博客、写评论、网站介绍、其他

example

示例URL数组，至少1个，最多5个，必须是完整的URL

可选字段

cost

发布费用（美元），数字类型，例如：0.5

contact_info

联系信息，字符串，例如：邮箱、QQ、微信等

page_authority

页面权重，整数，范围：1-100

favicon

网站图标URL，如果不提供，系统会自动获取

响应格式

成功响应

{
  "success": true,
  "data": {
    "id": 123,
    "url": "https://example.com",
    "title": "示例网站",
    "status": "待审核",
    "message": "外链提交成功，等待审核"
  }
}

错误响应

{
  "success": false,
  "error": "错误信息描述"
}

HTTP 状态码

200 - 请求成功
400 - 请求参数错误
401 - API Key 无效或未提供
500 - 服务器内部错误

注意事项

1. 审核流程：提交的外链需要管理员审核通过后才能生效。审核通过后您将获得1个信用点奖励。

2. 重复检查：系统会检查URL是否已存在，如果已存在会返回错误。

3. 内容验证：标题和描述中不能包含域名，系统会自动验证。

4. API Key 安全：请妥善保管您的 API Key，不要泄露给他人。如果怀疑 API Key 泄露，请及时重新生成。

5. 频率限制：为避免滥用，系统可能会对API调用频率进行限制。

快速链接

测试 API 接口

curl -X POST https://linktrx.jiahaoyg.xyz/api/v1/links/submit \ -H "x-api-key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://example.com", "title": "示例网站", "description": "这是一个示例网站的描述", "category": "技术平台", "publishType": "写文章", "example": ["https://example.com/article1"], "cost": 0.5, "contact_info": "contact@example.com", "page_authority": 50 }'

fetch('https://linktrx.jiahaoyg.xyz/api/v1/links/submit', { method: 'POST', headers: { 'x-api-key': 'YOUR_API_KEY', 'Content-Type': 'application/json', }, body: JSON.stringify({ url: 'https://example.com', title: '示例网站', description: '这是一个示例网站的描述', category: '技术平台', publishType: '写文章', example: ['https://example.com/article1'], cost: 0.5, contact_info: 'contact@example.com', page_authority: 50 }) }) .then(response => response.json()) .then(data => console.log(data)) .catch(error => console.error('Error:', error));

import requests url = 'https://linktrx.jiahaoyg.xyz/api/v1/links/submit' headers = { 'x-api-key': 'YOUR_API_KEY', 'Content-Type': 'application/json' } data = { 'url': 'https://example.com', 'title': '示例网站', 'description': '这是一个示例网站的描述', 'category': '技术平台', 'publishType': '写文章', 'example': ['https://example.com/article1'], 'cost': 0.5, 'contact_info': 'contact@example.com', 'page_authority': 50 } response = requests.post(url, headers=headers, json=data) print(response.json())