API maʼlumotnomasi
Barcha ochiq resurs, metod, kerakli ruxsat, sahifalash qoidasi va o‘zgartirish shartnomasini toping.
Barcha ochiq resurs, metod, kerakli ruxsat, sahifalash qoidasi va o‘zgartirish shartnomasini toping.
Kanonik mashina o‘qiydigan shartnoma — OpenAPI JSON. Bu sahifa inson o‘qiydigan amallar indeksi va barcha endpointlar uchun umumiy qoidalarni tushuntiradi.
Asosiy URL va versiya#
https://makeagent.fast/api/v1Asosiy versiya yo‘lning bir qismi. Yangi qo‘shimcha maydonlar major versiyasiz paydo bo‘lishi mumkin, shuning uchun nomaʼlum javob maydonlarini eʼtiborsiz qoldiring. Barcha boshqaruv so‘rovlari HTTPS va bearer API kaliti yoki OAuth access tokendan foydalanadi.
Umumiy sarlavhalar#
Authorization: Bearer maf_live_...
Accept: application/json
Content-Type: application/json
Idempotency-Key: your-stable-operation-keyContent-Type POST va PATCH JSON tanalari, jumladan {} uchun majburiy. Idempotency-Key ixtiyoriy, ammo har bir POST, PATCH va DELETE uchun qatʼiy tavsiya qilinadi.
Hisob va saytlar#
| Metod | Yo‘l | Ruxsat | Vazifasi |
|---|---|---|---|
GET | /me | account:read | Hisob, tarif, huquq va hamyon xulosasini o‘qish |
GET | /sites | sites:read | Egaga tegishli saytlarni ro‘yxatlash |
POST | /sites | sites:write | Sayt va standart agentini yaratish |
GET | /sites/{site_id} | sites:read | Bitta tegishli saytni olish |
PATCH | /sites/{site_id} | sites:write | Xavfsiz sayt maydonlarini yangilash |
POST | /sites/{site_id}/publish | sites:write | { "published": boolean } bilan nashr qilish yoki olish |
GET | /sites/{site_id}/agent | agents:read | Agent sozlamalarini o‘qish |
PATCH | /sites/{site_id}/agent | agents:write | Persona, ko‘rsatma, ovoz, til, embed holati yoki manzillarni yangilash |
Sayt yaratish title va content.headline talab qiladi. Ixtiyoriy maydonlarga slug, type, template, qo‘shimcha kontent, persona_mode va en, ko, uz, rudan bir-to‘rtta til kiradi.
Bilim va FAQʼlar#
| Metod | Yo‘l | Ruxsat | Vazifasi |
|---|---|---|---|
GET | /sites/{site_id}/knowledge | knowledge:read | Bilim manbalarini ro‘yxatlash |
POST | /sites/{site_id}/knowledge | knowledge:write | { "name", "text" }ni qabul qilish; matn 5–200 000 belgi |
DELETE | /sites/{site_id}/knowledge/{source_id} | knowledge:write | Bitta manbani kelajakdagi qidiruvdan o‘chirish |
GET | /sites/{site_id}/faqs | knowledge:read | Tuzilmali FAQʼlarni ro‘yxatlash |
POST | /sites/{site_id}/faqs | knowledge:write | { "question", "answer", "approved" } yaratish |
PATCH | /sites/{site_id}/faqs/{faq_id} | knowledge:write | Savol, javob yoki tasdiq holatini yangilash |
DELETE | /sites/{site_id}/faqs/{faq_id} | knowledge:write | FAQʼni o‘chirish |
Ochiq API kiritilgan matnni qabul qiladi. URL crawl, fayl yuklash, YouTube, podcast va feed jarayoni uchun boshqaruv panelidan foydalaning.
Suhbatlar, lidlar, tahlil va foydalanish#
| Metod | Yo‘l | Ruxsat | Vazifasi |
|---|---|---|---|
GET | /sites/{site_id}/conversations | conversations:read | Suhbatlarni ro‘yxatlash |
GET | /sites/{site_id}/conversations/{conversation_id} | conversations:read | Suhbat va sahifalangan xabarlarini olish |
GET | /sites/{site_id}/leads | leads:read | Yig‘ilgan lidlarni ro‘yxatlash |
POST | /sites/{site_id}/leads | leads:write | Aniq rozilik va aloqa tanlovi bilan canonical lid yaratish |
GET | /sites/{site_id}/leads/{lead_id} | leads:read | Bitta lidni olish |
PATCH | /sites/{site_id}/leads/{lead_id} | leads:write | Lidni yangilash, qualify qilish yoki aloqa siyosatini o‘zgartirish |
POST | /sites/{site_id}/leads/{lead_id}/accept | leads:write | Lidni imkoniyat pipelineʼiga qabul qilish |
GET | /sites/{site_id}/analytics | analytics:read | Tahlil hodisalarini ro‘yxatlash |
GET | /sites/{site_id}/usage | usage:read | O‘lchangan foydalanish hodisalarini ro‘yxatlash |
Bu hodisa va faollik to‘plamlari limit va cursor qabul qiladi. Qaytgan yozuvlarda shaxsiy maʼlumot bo‘lishi mumkin; ularni maxfiylik majburiyatingizga muvofiq saqlang va eksport qiling.
Xaridor xabari yuborish va egasi javobi ochiq API amali emas. Lid o‘zgartirish qo‘llanadi, ammo himoya qilinadigan rozilik yozuvisiz consent_status: granted o‘rnatmang. Nomaʼlum rozilik ommaviy xabardan chiqariladi.
Imkoniyat pipelineʼi va CRM natijalari#
| Metod | Yo‘l | Ruxsat | Vazifasi |
|---|---|---|---|
GET / POST | /sites/{site_id}/pipeline/stages | pipeline:read / pipeline:write | Bosqichlarni ko‘rish yoki sozlash |
GET / POST | /sites/{site_id}/pipeline/accounts | pipeline:read / pipeline:write | Biznes hisoblarini ko‘rish yoki yaratish |
GET | /sites/{site_id}/pipeline/accounts/{account_id} | pipeline:read | Biznes hisobini olish |
GET / POST | /sites/{site_id}/pipeline/opportunities | pipeline:read / pipeline:write | Imkoniyatlarni ko‘rish yoki yaratish |
GET / PATCH | /sites/{site_id}/pipeline/opportunities/{opportunity_id} | pipeline:read / pipeline:write | Faollikni o‘qish yoki masʼul, qiymat, bosqich, keyingi amal va inson javobini yangilash |
POST | /sites/{site_id}/pipeline/outcomes | pipeline:write | CRM manbali won/lost natijani idempotent import qilish |
GET | /sites/{site_id}/pipeline/sync-records | pipeline:read | Sinxronlash holati, urinish va xatolarni ko‘rish |
POST | /sites/{site_id}/pipeline/sync-records/{sync_record_id}/retry | pipeline:write | Saqlangan payload orqali muvaffaqiyatsiz natijani qayta urinish |
Berilgan CRM provider, tashqi ID va idempotency kaliti audit tarixida qoladi. Qayta urinish faqat muvaffaqiyatsiz yozuvni talab qiladi va jarayondagi tashqi yozishni noto‘g‘ri muvaffaqiyat deb ko‘rsatmaydi.
Konnektorlar va domenlar#
| Metod | Yo‘l | Ruxsat | Vazifasi |
|---|---|---|---|
GET | /sites/{site_id}/connectors | connectors:read | Sirlarni bermasdan konnektor holatini ro‘yxatlash |
POST | /sites/{site_id}/connectors | connectors:write | Kanal konnektorini yaratish/almashtirish va webhookini sozlash |
PATCH | /sites/{site_id}/connectors/{connector_id} | connectors:write | status yoki reply_with_voiceni o‘rnatish |
DELETE | /sites/{site_id}/connectors/{connector_id} | connectors:write | Konnektorni provayderdan uzish va olib tashlash |
GET | /sites/{site_id}/domains | domains:read | Olib tashlangan — 409. Maxsus domenlar taklif etilmaydi |
POST | /sites/{site_id}/domains | domains:write | Olib tashlangan — 409 |
PATCH | /sites/{site_id}/domains/{domain_id} | domains:write | Olib tashlangan — 409 |
POST | /sites/{site_id}/domains/{domain_id}/verify | domains:write | Olib tashlangan — 409 |
DELETE | /sites/{site_id}/domains/{domain_id} | domains:write | Olib tashlangan — 409 |
Konnektor yaratish kanal bo‘yicha ajratilgan tanadan foydalanadi. credentials maydonlari telegram, whatsapp, messenger, instagram, discord va kakao uchun farq qiladi; sir yuborishdan oldin mos konnektor qo‘llanmasidan foydalaning.
Ommaviy xabar, bildirishnoma va monetizatsiya#
| Metod | Yo‘l | Ruxsat | Vazifasi |
|---|---|---|---|
GET | /sites/{site_id}/broadcasts | broadcasts:read | Ommaviy xabarlarni ro‘yxatlash |
POST | /sites/{site_id}/broadcasts | broadcasts:write | Kakao ommaviy xabar qoralamasini yaratish |
POST | /sites/{site_id}/broadcasts/{broadcast_id}/send | broadcasts:write | Mavjud qoralamani navbatga qo‘yish; 202 qaytaradi |
GET | /sites/{site_id}/notifications | notifications:read | Ega bildirishnomalarini ro‘yxatlash |
PATCH | /sites/{site_id}/notifications/{notification_id} | notifications:write | { "read": boolean } bilan o‘qilgan/o‘qilmagan deb belgilash |
GET | /sites/{site_id}/monetization/products | monetization:read | Sayt mahsulotlarini ro‘yxatlash |
POST | /sites/{site_id}/monetization/products | monetization:write | Kirish, maslahat, choychaqa yoki raqamli mahsulot yaratish |
PATCH | /sites/{site_id}/monetization/products/{product_id} | monetization:write | Mahsulot maydonlari va faol holatini yangilash |
DELETE | /sites/{site_id}/monetization/products/{product_id} | monetization:write | Mahsulotni o‘chirish |
Ommaviy xabar yaratish hozir faqat kakao kanalini qabul qiladi. Yetib boriladigan qabul qiluvchi yo‘q yoki xabar qoralama bo‘lmasa, navbatga qo‘yish 409 conflict bilan ishlamaydi.
Dasturchi webhooklari#
| Metod | Yo‘l | Ruxsat | Vazifasi |
|---|---|---|---|
GET | /webhook-endpoints | webhooks:read | Imzolash sirisiz endpoint holatini ro‘yxatlash |
POST | /webhook-endpoints | webhooks:write | Ochiq HTTPS URLʼni ro‘yxatdan o‘tkazish va imzolash sirini bir marta ko‘rsatish |
DELETE | /webhook-endpoints/{endpoint_id} | webhooks:write | Endpointni o‘chirish va kelajakdagi yetkazishni to‘xtatish |
Webhook URL HTTPS ishlatishi, hisob maʼlumoti yoki maxsus port saqlamasligi va faqat ochiq IP manzillarga yechilishi kerak.
Sahifalash#
Sahifalangan to‘plamlar limit 1 dan 100 gacha qabul qiladi; standart 50. Qaytgan yopiq next_cursorni faqat bir xil to‘plam va filtr bilan ishlating.
{
"data": [],
"has_more": false,
"next_cursor": null
}Ayrim kichik sozlama to‘plamlari xuddi shu qobiqni has_more: false bilan qaytaradi va cursor talab qilmaydi.
Idempotency#
Idempotency kaliti harf, raqam, ., _, : va -dan iborat 8–200 belgi bo‘lishi kerak. Natijalar 24 soat saqlanadi va hisob maʼlumoti egasi bo‘yicha cheklanadi.
- Bir xil kalit va bir xil metod, yo‘l, query hamda tana: saqlangan javobni
x-idempotent-replayed: truebilan qaytaradi. - Bir xil kalit boshqa kiritma bilan:
409 conflictqaytaradi. - Birinchi so‘rov ishlayotganida bir xil kalit:
409 conflictvaRetry-After: 2qaytaradi.
O‘zgartirish yuborishdan oldin kalitni doimiy saqlang va faqat o‘sha mantiqiy amal qayta urinishlarida qayta ishlating.
Javoblar va xatolar#
Muvaffaqiyatli javob resursni data ichiga o‘raydi. Yaratish amali odatda 201, navbatdagi ommaviy yuborish 202, boshqa muvaffaqiyatli amal 200 qaytaradi. Har bir javobda x-request-id bor va API maʼlumoti uchun Cache-Control: no-store ishlatiladi.
To‘liq xato kodlari uchun Ruxsatlar va xatolar, nusxalanadigan jarayonlar uchun API retseptlariga qarang.