प्रमाणीकरण

अपने 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);