การยืนยันตัวตน

เรียนรู้วิธียืนยันตัวตนสำหรับคำขอ API ของคุณ

การยืนยันตัวตน

คำขอทั้งหมดไปยัง Traceline API ต้องมี API key ในส่วนหัว X-API-Key สร้าง API key ได้จากแดชบอร์ด

X-API-Key: trl_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

รูปแบบคีย์

API key มีรูปแบบที่สอดคล้องกันเพื่อง่ายต่อการระบุ:

  • trl_live_ คีย์ทั้งหมดเริ่มต้นด้วย trl_live_
  • เนื้อหา อักขระฐานสิบหก 32 ตัวที่สร้างด้วยตัวสร้างสุ่มที่ปลอดภัยทางการเข้ารหัส
  • ตัวอย่างเต็ม trl_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

การจัดเก็บและความปลอดภัยของคีย์

API key ถูกแฮชด้วย SHA-256 บนเซิร์ฟเวอร์ คีย์แบบข้อความธรรมดาจะแสดงเพียงครั้งเดียวตอนสร้าง

แนวทางปฏิบัติด้านความปลอดภัย

  • เก็บคีย์ในตัวแปรสภาพแวดล้อม อย่าฮาร์ดโค้ด
  • เพิ่มไฟล์ .env ใน .gitignore
  • หมุนเวียนคีย์เป็นประจำและเพิกถอนคีย์ที่ไม่ใช้
  • ใช้คีย์แยกสำหรับการพัฒนาและการใช้งานจริง

ตัวอย่างคำขอ

คำขอทั้งหมดไปยัง Traceline API ต้องมี API key ในส่วนหัว X-API-Key สร้าง API key ได้จากแดชบอร์ด

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);