API کلیدیں اور توثیق

AskAIs Customer Service دو قسم کی اسناد فراہم کرتا ہے:

• API کلیدیں — تاکہ آپ کا بیک اینڈ ورک اسپیس کے طور پر REST API کو کال کرے
• اِن باکس خفیہ کلیدیں — وزیٹر کی شناختی پے لوڈ پر دستخط کرنے کے لیے

API کلیدیں

ترتیبات ← API Keys میں بنائیں۔ کلید صرف ایک بار دکھائی جاتی ہے۔ اسے bearer ٹوکن کے طور پر پاس کریں:

curl https://cs.askais.com/api/v1/conversations \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"

کسی بھی وقت منسوخ کریں — کلید کا ہیش محفوظ کیا جاتا ہے، سادہ متن نہیں۔

وزیٹر کی شناخت پر دستخط

لاگ اِن صارفین کے لیے، شناختی پے لوڈ پر سرور کی جانب سے دستخط کریں تاکہ کوئی بدنیت وزیٹر دوسرے صارفین کا روپ نہ دھار سکے:

// Node.js example
import { createHmac } from "node:crypto";

const payload = JSON.stringify({
  externalId: user.id,
  email: user.email,
  ts: Date.now(),
});

const signature = createHmac("sha256", INBOX_SECRET_KEY)
  .update(payload)
  .digest("hex");

res.json({ payload, signature });

پھر براؤزر میں، دونوں کو SingChat.identify() کو پاس کریں:

SingChat.identify(JSON.parse(payload), signature);

کلیدوں کی گردش

اِن باکس خفیہ کلید کی گردش پرانے دستخطوں کو فوراً غیر مؤثر کر دیتی ہے۔ تعیناتی کے وقفے کی منصوبہ بندی کریں؛ گردش کے بعد، جب تک آپ کا بیک اینڈ نئے دستخط شدہ پے لوڈ نہیں بھیجتا، کلائنٹس گمنام چیٹ پر واپس چلے جاتے ہیں۔

شرحِ حد

• عوامی API کلید: فی کلید 60 درخواستیں/منٹ (برسٹ 120)
• وجٹ شناخت: فی وزیٹر فی منٹ 10
• پیغام بھیجنا: فی گفتگو فی منٹ 30