ChatGetz API برای توسعه دهندگان

شروع سریع

1. وارد شوید و کلید های داشبورد → API را باز کنید.
2. یک کلید را با مجوز های که نیاز دارید ایجاد کنید و آنرا کاپی کنید (این فقط یک بار نشان داده میشود).
3. آنرا در سربرگ Authorization بفرستید: Bearer cgk_…

curl https://www.chatgetz.uz/api/v1/account/balance \
  -H "Authorization: Bearer $CHATGETZ_API_KEY"

curl https://www.chatgetz.uz/api/v1/ai/generate \
  -H "Authorization: Bearer $CHATGETZ_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f0c6f5e-order-42" \
  -d '{
    "model": "deepseek/deepseek-v4-flash",
    "prompt": "Write a 60-word description for a cotton kids hoodie",
    "instructions": "Answer in Uzbek (Latin script)."
  }'

تصدیق هویت و حوزه ها

هر درخواست نیاز به یک کلید شخصی API در سربرگ Authorization: Bearer cgk_… (یا X-API-Key) دارد. هر کلید مجوزات (حدود ها) و حد سرعت خود را دارد و در هر زمان میشود که لغو گردد.

کلیدها را روی سرور خود یا در تنظیمات نگه دارید، هیچگاه در کود عمومی جلو. ChatGetz فقط یک درهم ساز SHA-256 را برای هر کلید ذخیره میکند.

محدودیت ها و قیمت گذاری

• Global Pro: unlimited API requests.
• Basic: ۱٬۰۰۰ درخواست ها در ماه (تصویب شده در 1، وقت تاشکند).
• حساب های بدون پلان دسترسی به API ندارند.
• هر کلید محدودیت نرخ خود را دارد (10–120 درخواست درق دقیقه). در بالای این حد، API به 429 با سر بعد از تلاش مجدد پاسخ میدهد.
• برای تولید متن AI از لیست قیمت عمومی استفاده میشود: اول از مبلغ ماهانه خود، بعد از توازن ChatGetz.
• یک سربرگ Idempotency-Key را با درخواست های AI بفرستید: یک درخواست تلاش مجدد با همان کلید هیچگاه دوبار در نظر گرفته نمیشود.

نقطه پایانی

• get/api/v1/account/balanceاین پلان، متوازن کردن، شامل معافیت AI و API کوت بودaccount:read
• get/api/v1/modelsمدل های متن و موجودیت آنها برای کلید شماai:generate
• post/api/v1/ai/generateمتن را ایجاد کنید؛ از حساب (اولاً اضافه شدن مبلغ)ai:generate
• get/api/v1/market/listingsلیست بازار ChatGetz شماmarket:read
• post/api/v1/market/listingsیک لیست بازار را ایجاد کنید (بطور پیشفرض یک طرح)market:write
• post/api/v1/ingest/eventsدریافت کردن یک سفارش یا پیشنهاد از یک پلاگین (وب سایت)ingest:write
• get/api/v1/openapi.jsonمشخصات OpenAPI 3.1 این API

پلاگین ها دستورالعمل های جدید را می کشند و به POST /api/v1/ingest/events. منجر میشود فرستادن مجدد یک رویداد با همان منبع، نوع و externalId امن است: این فقط یک بار ذخیره شده است.

curl https://www.chatgetz.uz/api/v1/ingest/events \
  -H "Authorization: Bearer $CHATGETZ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "order", "source": "woocommerce", "externalId": "1042",
    "customer": { "name": "Aziza", "phone": "+998901234567" },
    "total": { "amount": "249000", "currency": "UZS" },
    "items": [{ "name": "Hoodie", "quantity": 1, "price": "249000" }]
  }'

خطاها

خطا JSON با یک کود ماشین قابل خواندن ثابت و پیام انگلیسی است. یکجا سازی خود را روی کود بسازید.

{
  "error": {
    "code": "quota_exceeded",
    "message": "Monthly Basic API quota exhausted. ..."
  }
}

پلگ ان ها

تمام ها منبع باز (متوافق با GPL) هستند و از کلید API شما استفاده میکنند. کلید در تنظیمات پلاگین ذخیره شده است، هیچگاه در کود.