احراز هویت

هدر Authorization

هر درخواست به /v1 باید کلید توسعه‌دهنده را در هدر Authorization و به شکل Bearer <key> بفرستد. کلیدها با hvd_ شروع می‌شوند.

curl https://api.hoveydai.ir/v1/models \  -H "Authorization: Bearer $HOVEYDAI_API_KEY"

اگر از کتابخانهٔ کلاینت استفاده می‌کنید، کلید را در گزینهٔ مربوط به API key آن بدهید؛ این کتابخانه‌ها خودشان همین هدر را می‌سازند و لازم نیست چیزی اضافه کنید.

خطای احراز هویت

اگر کلید نباشد، نادرست باشد یا حذف شده باشد، پاسخ 401 با یک شیء JSON به نام error است که type آن authentication_error و code آن invalid_api_key است. کدهای token_expired و session_revoked فقط وقتی دیده می‌شوند که به‌جای کلید، توکن ورود به پنل را بفرستید. قالب کامل و راه‌حل هر کد در صفحهٔ خطاها آمده است.

نگهداری کلید

• کلید را در متغیر محیطی یا مدیر رازها نگه دارید، نه در مخزن کد و نه در کد مرورگر.
• برای هر برنامه کلید جدا بسازید. هم مصرف و هزینهٔ هر برنامه جدا دیده می‌شود و هم اگر کلیدی لو رفت فقط همان را حذف می‌کنید.
• هر درخواست به حساب همان کلید نوشته می‌شود و محدودیت درخواست هم برای هر کلید جدا حساب می‌شود.