文档导航

快速开始 快速入门 功能介绍 API文档 常见问题

API文档

青鸽短链云提供完善的API接口，方便开发者集成短链功能到自己的应用中。

API概述

Base URL

https://short.24cod.com/api/v1

认证方式

API Key

请求格式

JSON

响应格式

JSON

认证说明

所有API请求都需要在请求头中包含API Key进行身份验证。

Authorization: Bearer YOUR_API_KEY

请在控制台获取您的API Key。

创建短链

POST /shorten

创建一个新的短链接（随机短码）。

请求参数

参数名 类型 必填 说明
url string 是 目标链接
title string 否 短链标题
description string 否 短链描述

请求示例

{
  "url": "https://example.com/very-long-url",
  "title": "我的短链",
  "description": "这是一个示例短链"
}

响应示例

{
  "code": 200,
  "message": "success",
  "data": {
    "id": "123456",
    "short_url": "https://short.24cod.com/AbC123",
    "original_url": "https://example.com/very-long-url",
    "created_at": "2026-01-19T10:30:00Z"
  }
}

查询短链

GET /links/{id}

根据短链ID查询短链详情。

路径参数

参数名 类型 必填 说明
id string 是 短链ID

响应示例

{
  "code": 200,
  "message": "success",
  "data": {
    "id": "123456",
    "short_url": "https://short.24cod.com/AbC123",
    "original_url": "https://example.com/very-long-url",
    "title": "我的短链",
    "description": "这是一个示例短链",
    "clicks": 100,
    "created_at": "2026-01-19T10:30:00Z"
  }
}

获取统计

GET /stats/{id}

获取短链的访问统计数据。

响应示例

{
  "code": 200,
  "message": "success",
  "data": {
    "total_clicks": 1000,
    "unique_clicks": 800,
    "devices": {
      "mobile": 600,
      "desktop": 400
    },
    "locations": [
      {"country": "中国", "clicks": 800},
      {"country": "美国", "clicks": 200}
    ],
    "sources": [
      {"source": "direct", "clicks": 500},
      {"source": "social", "clicks": 300},
      {"source": "search", "clicks": 200}
    ]
  }
}

错误码

错误码 说明
400 请求参数错误
401 未授权，API Key无效
403 无权限访问
404 资源不存在
429 请求频率超限
500 服务器内部错误
0.012134s