认证

了解如何认证您的 API 请求。

认证

Traceline API的所有请求必须在X-API-Key标头中包含API密钥。API密钥可从仪表板生成。

X-API-Key: trl_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

密钥格式

API密钥遵循一致的格式以便识别:

  • trl_live_ 所有密钥以trl_live_开头,便于识别和密钥扫描。
  • 主体 由加密安全随机生成器生成的32个十六进制字符。
  • 完整示例 trl_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

密钥存储与安全

API密钥在服务器上使用SHA-256进行哈希处理。明文密钥仅在创建时显示一次,之后无法检索。如果丢失密钥,请撤销并创建新密钥。

安全最佳实践

  • 将密钥存储在环境变量中,切勿硬编码。
  • 将.env文件添加到.gitignore以防止意外提交。
  • 定期轮换密钥并撤销未使用的密钥。
  • 开发和生产使用不同的密钥。

请求示例

Traceline API的所有请求必须在X-API-Key标头中包含API密钥。API密钥可从仪表板生成。

cURL

curl -X POST https://api.trace-line.site/v1/palm/analyze \
  -H "X-API-Key: trl_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"image": "<base64-encoded-image>"}'

Python

import os
import requests
import base64

api_key = os.environ["TRACELINE_API_KEY"]

with open("palm.jpg", "rb") as f:
    image_b64 = base64.b64encode(f.read()).decode()

response = requests.post(
    "https://api.trace-line.site/v1/palm/analyze",
    headers={
        "X-API-Key": api_key,
        "Content-Type": "application/json",
    },
    json={"image": image_b64},
)

print(response.json())

JavaScript

import { readFileSync } from "fs";

const apiKey = process.env.TRACELINE_API_KEY;
const image = readFileSync("palm.jpg").toString("base64");

const res = await fetch(
  "https://api.trace-line.site/v1/palm/analyze",
  {
    method: "POST",
    headers: {
      "X-API-Key": apiKey,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ image }),
  }
);

const data = await res.json();
console.log(data);