مستندات توسعه‌دهندگان

احراز هویت

برای دسترسی به API چارتیکال، کلید API خود را در هدر x-api-key درخواست ارسال کنید.

روش احراز هویت

در هر درخواست به API، کلید معتبر خود را در هدر x-api-key قرار دهید.

API Key

هدر درخواست

الزامی

x-api-key:YOUR_API_KEY

POSThttps://api.chartical.com/api/v1/chat

نمونه درخواست

در این مثال، کلید API از متغیر محیطی خوانده می‌شود و همراه درخواست به سرور ارسال می‌شود.

این نمونه از API چت چارتیکال استفاده می‌کند. مقادیر slug، model و messages را متناسب با درخواست خود تنظیم کنید.

javascript

const apiKey=process.env.CHARTICAL_API_KEY
if (!apiKey) {
  throw new Error("CHARTICAL_API_KEY is not configured");
}
const headersList = {
  "x-api-key": apiKey,
  "Content-Type": "application/json"
  }

const bodyContent = JSON.stringify({
  "slug":"education-and-research/parent-teacher",
  "model":"smart",
  "tools":{"webSearch":"never"},
  "messages":[{
    "role":"user",
    "content":"Hello!"
  }]
});

const response = await fetch("https://api.chartical.com/api/v1/chat", { 
  method: "POST",
  body: bodyContent,
  headers: headersList
});

const data = await response.text();
console.log(data);

اجزای درخواست

هر بخش چه نقشی در احراز هویت و ارسال درخواست دارد؟

x-api-key

کلید API اختصاصی حساب شماست و سرور از آن برای شناسایی و بررسی دسترسی درخواست استفاده می‌کند.

Content-Type

با مقدار application/json مشخص می‌کند که بدنه درخواست با فرمت JSON ارسال می‌شود.

Endpoint

درخواست نمونه به مسیر /api/v1/chat ارسال می‌شود و از متد POST استفاده می‌کند.

متغیر محیطی

این مقدار را در محیط سرور خود تنظیم کنید و نام آن را با تنظیمات پروژه هماهنگ نگه دارید.

.env

CHARTICAL_API_KEY=ch-your-api-key

نکات امنیتی

با رعایت این موارد، کلید API را امن‌تر نگه دارید.

کلید را در فرانت‌اند قرار ندهید

در برنامه‌های مرورگری، کلید را در کد JavaScript سمت کاربر، localStorage یا درخواست‌های قابل مشاهده در مرورگر قرار ندهید. درخواست را از سرور خود ارسال کنید.

از متغیر محیطی استفاده کنید

کلید را در متغیر محیطی سمت سرور ذخیره کنید و از قرار دادن آن در مخزن Git خودداری کنید.

کلید را به اشتراک نگذارید

کلید API مانند یک اعتبارنامه محرمانه است. آن را در اسکرین‌شات‌ها، لاگ‌های عمومی یا کدهای منتشرشده قرار ندهید.

اگر احراز هویت موفق نبود

اگر درخواست رد شد، ابتدا موارد زیر را بررسی کنید. وضعیت دقیق و متن خطا به پاسخ API بستگی دارد.

مطمئن شوید هدر x-api-key ارسال شده است.

کلید API را از نظر صحت و کامل بودن بررسی کنید.

بررسی کنید کلید در سمت سرور به‌درستی از متغیر محیطی خوانده می‌شود.

وضعیت HTTP و متن پاسخ سرور را برای جزئیات خطا بررسی کنید.

ساختار پاسخ نمونه در این صفحه نمایش داده نشده است؛ برای مشاهده پارامترهای واقعی پاسخ، به مرجع API مراجعه کنید.

برای یکپارچه‌سازی به راهنمایی نیاز دارید؟

اگر در ارسال درخواست، احراز هویت یا استفاده از دستیارها به مشکل برخوردید، از راهنماهای فنی استفاده کنید یا با پشتیبانی چارتیکال ارتباط بگیرید.

ارتباط با پشتیبانی