文档

开发者文档和集成指南

将 Valqor 集成到您的技术栈所需的一切。

快速入门

创建您的第一个品牌链接，设置自定义域名，并探索仪表板。

注册并创建您的工作区
在仪表板 → 域名中添加自定义域名
使用品牌 slug 创建您的第一个链接
在仪表板查看实时分析数据

API 参考

用于链接、域名、分析和 API 密钥管理的 REST API，支持限定范围的权限。

身份验证

在仪表板 → API 密钥中生成 API 密钥，并将其作为 Bearer 令牌发送：

Authorization: Bearer vq_your_key_here

集成

将 Valqor 连接到您的 CRM、CI/CD 流水线、营销平台和分析工具。

Webhooks — 实时事件通知（仅限 HTTPS）
CSV 导入/导出 — 批量管理链接
转化跟踪 — 基于像素的归因
GA4 — 自动添加 UTM 参数标记

REST API

API 端点

基础 URL： https://valqor.app

POST/api/links

创建新的品牌链接

示例

curl -X POST https://valqor.app/api/links \
  -H "Authorization: Bearer vq_..." \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "go.example.com",
    "slug": "launch",
    "destination": "https://example.com/product",
    "tags": ["marketing", "launch-2025"]
  }'

GET/api/links

列出工作区中的所有链接

示例

curl https://valqor.app/api/links \
  -H "Authorization: Bearer vq_..."

PATCH/api/links/:id

更新现有链接

示例

curl -X PATCH https://valqor.app/api/links/lnk_abc123 \
  -H "Authorization: Bearer vq_..." \
  -H "Content-Type: application/json" \
  -d '{ "destination": "https://example.com/new-page" }'

DELETE/api/links/:id

永久删除链接

示例

curl -X DELETE https://valqor.app/api/links/lnk_abc123 \
  -H "Authorization: Bearer vq_..."

GET/api/analytics

获取链接的分析数据

示例

curl "https://valqor.app/api/analytics?period=30d" \
  -H "Authorization: Bearer vq_..."

GET/api/domains

列出已配置的自定义域名

示例

curl https://valqor.app/api/domains \
  -H "Authorization: Bearer vq_..."

限制

速率限制

API 速率限制按 API 密钥计算，采用滑动窗口机制。

Free60 req/min

Pro600 req/min

Business6 000 req/min

约定

响应格式

成功

{
  "item": { "id": "lnk_abc123", "slug": "launch", ... }
}

错误

{
  "error": "Slug is already taken",
  "code": "SLUG_COLLISION"
}

前往仪表板