認証

APIリクエストの認証方法を学びます。

認証

Traceline APIへのすべてのリクエストには、X-API-KeyヘッダーにAPIキーを含める必要があります。APIキーはダッシュボードから生成できます。

X-API-Key: trl_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

キー形式

APIキーは識別しやすい一貫した形式に従います：

trl_live_ — すべてのキーは識別とシークレットスキャンのためにtrl_live_で始まります。
本体 — 暗号学的に安全な乱数生成器で生成された32文字の16進数。
完全な例 — 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);