مستندات API
۱. ثبتنام
از صفحه ثبتنام با ایمیل و رمز عبور (حداقل ۸ کاراکتر) حساب بسازید. اگر سرویس ایمیل فعال باشد، لینک تأیید برای شما ارسال میشود و تأیید ایمیل پیش از خرید الزامی است.
۲. خرید اعتبار
- در داشبورد به «خرید اعتبار» بروید و یک بسته یا مبلغ دلخواه انتخاب کنید.
- سفارش ایجاد میشود و دستورالعمل پرداخت نمایش داده میشود.
- پس از پرداخت، شماره پیگیری/مرجع تراکنش را در صفحه سفارش ثبت کنید.
- پس از بررسی و تأیید مدیر، اعتبار به کیف پول افزوده میشود. تصویر رسید بهتنهایی مدرک پرداخت محسوب نمیشود.
۳. ساخت و ابطال کلید
در «کلیدهای API» نام کلید و (اختیاری) مدلهای مجاز را انتخاب کنید. کلید فقط یکبار نمایش داده میشود؛ آن را در جای امن ذخیره کنید. برای ابطال، دکمه «ابطال» را بزنید؛ کلید فوراً در درگاه حذف میشود. در صورت گمشدن کلید، آن را باطل و کلید جدید بسازید.
۴. آدرس پایه و احراز هویت
Base URL: https://api.iranservices26.ir/v1 Authorization: Bearer sk-...
۵. مدلها و مسیرها
POST /chat/completions— تولید پاسخ گفتگو (فرمت OpenAI)GET /models— فهرست مدلهای مجاز برای کلید شما
مسیرهای دیگر (embedding، تصویر و …) فقط در صورتی که در ستون «قابلیتها» برای یک مدل ذکر شده باشد پشتیبانی میشوند. فهرست مدلهای فعال: مدلها و قیمتها.
۶. نمونه Python (SDK سازگار با OpenAI)
pip install openai
from openai import OpenAI
client = OpenAI(
base_url="https://api.iranservices26.ir/v1",
api_key="sk-...", # کلید اختصاصی شما
)
resp = client.chat.completions.create(
model="MODEL_ID",
messages=[{"role": "user", "content": "سلام!"}],
)
print(resp.choices[0].message.content)۷. نمونه cURL
curl https://api.iranservices26.ir/v1/chat/completions \
-H "Authorization: Bearer $IS26_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "MODEL_ID",
"messages": [{"role": "user", "content": "سلام!"}]
}'۸. خطاها و رفع اشکال
| کد | معنی | راهحل |
|---|---|---|
| 401 | کلید نامعتبر یا باطلشده | کلید و هدر Authorization را بررسی کنید. |
| 403 / 401 (blocked) | کلید مسدود (مثلاً موجودی صفر) | اعتبار بخرید؛ پس از تأیید، کلید خودکار فعال میشود. |
| 400 | درخواست نامعتبر یا مدل غیرمجاز برای کلید | نام مدل و بدنه JSON را بررسی کنید. |
| 429 | محدودیت نرخ | با تأخیر و backoff دوباره تلاش کنید. |
| 500 / 502 / 503 | خطای درگاه یا ارائهدهنده بالادستی | چند لحظه بعد تلاش کنید و وضعیت سرویس را ببینید. |
۹. مصرف، محدودیت و قیمت
- هزینه هر درخواست بر اساس توکنهای ورودی و خروجی و قیمت مدل (تومان به ازای ۱ میلیون توکن) محاسبه و به بالا گرد میشود.
- مصرف بهصورت دورهای از درگاه همگامسازی و از کیف پول کسر میشود؛ بنابراین ارقام داشبورد با کمی تأخیر بهروز میشوند.
- اگر موجودی به صفر یا کمتر برسد، کلیدها مسدود میشوند. بهدلیل همگامسازی دورهای، ممکن است موجودی بهطور موقت کمی منفی شود که از خرید بعدی کسر خواهد شد.
- حداکثر ۱۰ کلید فعال برای هر حساب.
۱۰. امنیت کلید API
- کلید را هرگز در کد سمت مرورگر یا اپلیکیشن موبایل قرار ندهید؛ از سرور خود درخواست بزنید.
- کلید را در متغیر محیطی نگه دارید و در مخزن git ثبت نکنید.
- برای هر پروژه کلید جدا بسازید و مدلها را محدود کنید.
- در صورت افشا، فوراً کلید را باطل کنید.