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)."
  }'

Аутентификация және ауқымдар

Әрбір сұраныс үшін Authorization: Bearer cgk_… (не X-API-Key) айдарында жеке API кілт қажет. Әрбір перненің өз рұқсаттары (ауқымы) және жылдамдығы шектеуі бар, кез-келген уақытта қайтарылуы мүмкін.

Кілттерді серверіңізде немесе плагин параметрлерінде сақтаңыз, ешқашан ашық фронтальды кодта емес. ChatGetz әрбір кілттің тек SHA-256 хешін ғана сақтайды.

Лимиттер мен бағалар

• Global Pro: шексіз API сұраныс.
• Basic: 1 000 запроса в месяц (сброс 1-го числа по ташкентскому времени).
• Бағдарламасыз шоттар API-ге кіре алмайды.
• Әрбір кілтке өзінің жылдамдық шегі бар (минута 10-120 сұраныс). Шектеуден асқан жағдайда API Retry-After атауы бар 429 жауап береді.
• текст генерациясы бойынша төлемдер бағалар тізіміне сәйкес жүргізіледі: алдымен айлық ОО-ға арналған аударымдарыңыздан, сосын сіздің ChatGetz балансынан.
• AI сұраныстарына Idempotency-Key айдарын жіберу: бірдей кілтпен қайталанған сұраныс ешқашан екі рет төленбейді.

Қорытынды нүктелер

• get/api/v1/account/balanceПлан, баланс, ҰБТ-ға арналған төлем және API квота кіредіaccount:read
• get/api/v1/modelsМәтіндік модельдер және олардың кілтіңізге қолжетімділігіai:generate
• post/api/v1/ai/generateТекстті құру; баланстан есептелген (алғашқы төлем кіреді)ai:generate
• get/api/v1/market/listingsСіздің ChatGetz Market тізімдеріmarket:read
• post/api/v1/market/listingsMarket тізімін құру (әдетте, драфт)market:write
• post/api/v1/ingest/eventsПлагиннен (веб-бот) тапсырыс немесе өтінім алуingest:write
• get/api/v1/openapi.jsonOpenAPI 3.1 спецификациясы осы API

Плагиндер жаңа тапсырмаларды жіберіп POST /api/v1/ingest/events. нәтижесіне алып келеді Оқиғаны қайта жүктеу, ол көзі, түрі және сыртқы идентификаторы бір болған жағдайда қауіпсіз: ол тек бір рет сақталады.

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 кілтіңізді пайдаланады. Кілт плагиннің параметрлерінде сақталады, ешқашан кодта.