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

EFARS API

احراز هویت

هدرهای اختصاصی هر پروتکل با یک کلید API ای‌فارس.

راهنمای اتصال مشتریان
curl · Python · JavaScript

هدر مناسب هر مسیر

برای همه مسیرهای زیر از کلید API صادرشده در حساب EFARS استفاده کنید، نه کلید مستقیم OpenAI، Anthropic یا Google.

پروتکلهدر کلیدهدرهای دیگر
OpenAIAuthorization: Bearer YOUR_EFARS_API_KEYContent-Type: application/json
Claudex-api-key: YOUR_EFARS_API_KEYanthropic-version: 2023-06-01 و Content-Type: application/json
Geminix-goog-api-key: YOUR_EFARS_API_KEYContent-Type: application/json

سازگاری ابزارها

مسیر Claude در نبود x-api-key و مسیر Gemini در نبود x-goog-api-key از Authorization: Bearer نیز پشتیبانی می‌کنند. در هر درخواست فقط یک روش اصلی ارسال کلید را انتخاب کنید. در Gemini کلید در query نیز قابل دریافت است، اما برای جلوگیری از ثبت در URL و لاگ، از هدر استفاده کنید.

نشانی پایه در ابزارها

نوع ابزارنشانی پایه
OpenAI-compatiblehttps://efars.com/v1
Anthropic-compatiblehttps://efars.com/claude
Gemini-compatiblehttps://efars.com/gemini

ابزارها مسیرهای نسخه و عملیات را متفاوت اضافه می‌کنند. URL نهایی باید دقیقاً با مرجع همان پروتکل یکسان باشد؛ از تکرار /v1 یا حذف /claude و /gemini جلوگیری کنید. برای ابزارهایی که فقط کلید می‌پذیرند و تغییر base URL ندارند، سازگاری با EFARS را جدا بررسی کنید.

امنیت و عیب‌یابی

  • کلید را فقط در سرور یا محیط مورد اعتماد نگه دارید.
  • خطای 401: مقدار کلید، انقضا، وضعیت و سقف کلید را بررسی کنید.
  • خطای 403: IP مجاز، گروه، مدل و مجوز عملیات را بررسی کنید.
  • کلید API با نشست ورود به پنل یا توکن مدیریت حساب یکسان نیست.