احراز هویت با کلید API

این صفحه نحوه احراز هویت در درگاه CLEVI با کلید API را توضیح می‌دهد.
در هر دو مسیر سازگار با OpenAI و سازگار با Anthropic، احراز هویت با یک کلید انجام می‌شود؛
محدوده مجاز هدر حاوی کلید و base URL که باید در SDK تنظیم شود، در هر استاندارد متفاوت است.

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

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

نام هدرها به حروف کوچک و بزرگ حساس نیستند. x-api-key ارسال‌شده توسط Anthropic SDK نیز بدون تغییر کار می‌کند.

base URL

SDK مورد استفاده شما با تغییر base URL به آدرس زیر، بدون تغییر کار می‌کند. تفاوت دو آدرس در این است که آیا /v1 را شامل می‌شوند یا خیر.

بررسی احراز هویت

با وارد کردن کلید و base URL و دریافت فهرست مدل‌ها، می‌توانید بلافاصله از انجام احراز هویت مطمئن شوید. هر سه نمونه زیر همین درخواست را با curl، OpenAI SDK و Anthropic SDK انجام می‌دهند.

curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
  -H "X-API-Key: sk-..."

curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
  -H "Authorization: Bearer sk-..." \
  -H "anthropic-version: 2023-06-01"

from openai import OpenAI

client = OpenAI(
    api_key="sk-...",
    base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)

for model in client.models.list():
    print(model.id)

from anthropic import Anthropic

client = Anthropic(
    api_key="sk-...",
    base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)

for model in client.models.list(limit=20).data:
    print(model.id)

در جای ...-sk، کلیدی را که از صفحه کلیدهای API صادر کرده‌اید وارد کنید.

• اگر پاسخ 200 باشد، احراز هویت انجام شده است. data شامل فهرست مدل‌هایی است که می‌توان با این کلید فراخوانی کرد.
• اگر پاسخ 401 باشد، موارد را طبق ترتیب بخش «شکست احراز هویت» زیر بررسی کنید.

هدرهای مورد استفاده هم‌زمان

همه موارد اختیاری هستند. برای ردیابی مشکل، بهتر است X-Request-Id را اضافه کنید.

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

اگر کلیدی وجود نداشته باشد یا کلید منقضی‌شده یا لغوشده ارسال شود، پاسخ 401 است. اگر در مسیر سازگار با OpenAI بدون کلید فراخوانی انجام شود، بدنه زیر برگردانده می‌شود و error.type در مسیر سازگار با Anthropic برابر authentication_error است.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

1. وضعیت کلید را در صفحه کلیدهای API بررسی کنید. اگر کلید منقضی یا لغو شده است، کلید جدیدی صادر کنید.
2. بررسی کنید نام هدر X-API-Key یا Authorization باشد.
3. اگر در مسیر سازگار با OpenAI از Authorization استفاده می‌کنید، پیشوند Bearer را بررسی کنید.