API 文档

HTML8.NET RESTful API 接口文档

版本 v1.0

概述

HTML8.NET API 为开发者提供了程序化访问我们服务的能力。通过 RESTful API， 您可以创建、管理和分享代码片段，无需通过 Web 界面。

REST 风格

标准的 HTTP 方法和状态码

JSON 格式

所有请求和响应均使用 JSON

安全认证

基于 Token 的身份验证

认证

使用 HTML8.NET API 需要有效的 API Token。只有高级用户可以申请 API Token。

获取 API Token

请先注册账户并升级为高级用户，然后在 API 管理页面申请 Token。审核通过后即可使用。

请求头设置

X-API-Token: your_api_token_here
Content-Type: application/json

示例请求

curl -X POST https://html8.net/api/save-code/ \
  -H "X-API-Token: your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "<h1>Hello World</h1>",
    "code_type": "html",
    "title": "我的测试代码"
  }'

API 端点

POST /api/save-code/

创建代码片段

保存一个新的代码片段并获取分享链接。

请求参数
参数 类型 必填 说明
code string 是 代码内容
code_type string 是 代码类型 (html, css, js, markdown, svg, mermaid)
title string 否 代码标题，默认为"未命名代码"
access_password string 否 访问密码 (4位数字)
is_public boolean 否 是否公开访问 (仅高级用户可设为true)
请求示例
{
  "code": "<h1>Hello World</h1><p>这是一个测试页面</p>",
  "code_type": "html",
  "title": "Hello World 示例",
  "access_password": "1234",
  "is_public": false
}
响应示例
{
  "success": true,
  "data": {
    "url": "https://html8.net/go/abc123/",
    "id": 12345,
    "short_id": "abc123",
    "title": "Hello World 示例",
    "code_type": "html",
    "access_password": "1234",
    "is_public": false,
    "created_at": "2025-01-14T10:30:00Z"
  }
}
POST /api/update-title/

更新代码标题

更新已创建的代码片段的标题。

请求参数
参数 类型 必填 说明
short_id string 是 代码片段的短ID
title string 是 新的标题
响应示例
{
  "success": true
}
POST /api/delete-code/

删除代码片段

删除指定的代码片段。只能删除自己创建的代码。

请求参数
参数 类型 必填 说明
short_id string 是 要删除的代码片段短ID
响应示例
{
  "success": true
}

错误处理

API 使用标准的 HTTP 状态码来表示请求的结果。所有错误响应都包含错误信息。

HTTP 状态码

状态码 说明
200请求成功
400请求参数错误
401认证失败
403权限不足
404资源不存在
429请求频率超限
500服务器内部错误

错误响应格式

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

使用限制

请求频率

每个 Token 每日最多 1000 次请求

超过限制将返回 429 错误

代码大小

单个代码片段最大 100KB

超过限制将返回 400 错误

权限控制

只能操作自己创建的代码

尝试操作他人代码将返回 403 错误

Token 有效期

Token 长期有效，除非被撤销

请妥善保管您的 Token

SDK 和示例

Python 示例

import requests

# 配置
API_TOKEN = "your_token_here"
BASE_URL = "https://html8.net"

headers = {
    "X-API-Token": API_TOKEN,
    "Content-Type": "application/json"
}

# 创建代码片段
data = {
    "code": "<h1>Hello from Python</h1>",
    "code_type": "html",
    "title": "Python 示例"
}

response = requests.post(
    f"{BASE_URL}/api/save-code/",
    headers=headers,
    json=data
)

if response.status_code == 200:
    result = response.json()
    print(f"代码已保存: {result['data']['url']}")
else:
    print(f"错误: {response.text}")

JavaScript 示例

const API_TOKEN = 'your_token_here';
const BASE_URL = 'https://html8.net';

async function createCodeSnippet() {
    const response = await fetch(`${BASE_URL}/api/save-code/`, {
        method: 'POST',
        headers: {
            'X-API-Token': API_TOKEN,
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({
            code: '<h1>Hello from JavaScript</h1>',
            code_type: 'html',
            title: 'JavaScript 示例'
        })
    });

    if (response.ok) {
        const result = await response.json();
        console.log(`代码已保存: ${result.data.url}`);
    } else {
        console.error('保存失败:', await response.text());
    }
}

createCodeSnippet();

获取更多帮助

如果您需要更多帮助或有问题，请通过 联系我们 页面与我们联系。 我们将竭诚为您提供技术支持。