المصادقة

تعلم كيفية مصادقة طلبات الواجهة البرمجية.

المصادقة

يجب أن تتضمن جميع الطلبات إلى Traceline API مفتاح API في رأس X-API-Key. يتم إنشاء مفاتيح API من لوحة التحكم.

X-API-Key: trl_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

تنسيق المفتاح

تتبع مفاتيح API تنسيقًا متسقًا لسهولة التعرف:

  • trl_live_ جميع المفاتيح تبدأ بـ trl_live_.
  • المتن 32 حرفًا سداسيًا عشريًا تم إنشاؤها بمولد عشوائي آمن تشفيريًا.
  • مثال كامل trl_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

تخزين المفاتيح والأمان

يتم تجزئة مفاتيح API باستخدام SHA-256 على خوادمنا. يتم عرض المفتاح النصي مرة واحدة فقط عند الإنشاء.

أفضل ممارسات الأمان

  • خزّن المفاتيح في متغيرات البيئة، ولا تضمّنها في الكود.
  • أضف ملفات .env إلى .gitignore.
  • قم بتدوير المفاتيح بانتظام وإلغاء غير المستخدمة.
  • استخدم مفاتيح منفصلة للتطوير والإنتاج.

أمثلة الطلبات

يجب أن تتضمن جميع الطلبات إلى Traceline API مفتاح API في رأس X-API-Key. يتم إنشاء مفاتيح 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);