Sahifa mazmuniga oʻtish
Hujjatlar
Make Agent Fast hujjatlari

API maʼlumotnomasi

Barcha ochiq resurs, metod, kerakli ruxsat, sahifalash qoidasi va o‘zgartirish shartnomasini toping.

Qisqacha koʻrinish

Barcha ochiq resurs, metod, kerakli ruxsat, sahifalash qoidasi va o‘zgartirish shartnomasini toping.

API soʻrovi yoʻliCheklangan kalit → versiyalangan resurs → imzolangan javob
Ilova / SDKBearer kalitimaf_live_…/api/v1/…ResursJSON
v160 ta amalJSON

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/v1

Asosiy 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-key

Content-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#

MetodYo‘lRuxsatVazifasi
GET/meaccount:readHisob, tarif, huquq va hamyon xulosasini o‘qish
GET/sitessites:readEgaga tegishli saytlarni ro‘yxatlash
POST/sitessites:writeSayt va standart agentini yaratish
GET/sites/{site_id}sites:readBitta tegishli saytni olish
PATCH/sites/{site_id}sites:writeXavfsiz sayt maydonlarini yangilash
POST/sites/{site_id}/publishsites:write{ "published": boolean } bilan nashr qilish yoki olish
GET/sites/{site_id}/agentagents:readAgent sozlamalarini o‘qish
PATCH/sites/{site_id}/agentagents:writePersona, 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#

MetodYo‘lRuxsatVazifasi
GET/sites/{site_id}/knowledgeknowledge:readBilim manbalarini ro‘yxatlash
POST/sites/{site_id}/knowledgeknowledge:write{ "name", "text" }ni qabul qilish; matn 5–200 000 belgi
DELETE/sites/{site_id}/knowledge/{source_id}knowledge:writeBitta manbani kelajakdagi qidiruvdan o‘chirish
GET/sites/{site_id}/faqsknowledge:readTuzilmali FAQʼlarni ro‘yxatlash
POST/sites/{site_id}/faqsknowledge:write{ "question", "answer", "approved" } yaratish
PATCH/sites/{site_id}/faqs/{faq_id}knowledge:writeSavol, javob yoki tasdiq holatini yangilash
DELETE/sites/{site_id}/faqs/{faq_id}knowledge:writeFAQʼ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#

MetodYo‘lRuxsatVazifasi
GET/sites/{site_id}/conversationsconversations:readSuhbatlarni ro‘yxatlash
GET/sites/{site_id}/conversations/{conversation_id}conversations:readSuhbat va sahifalangan xabarlarini olish
GET/sites/{site_id}/leadsleads:readYig‘ilgan lidlarni ro‘yxatlash
POST/sites/{site_id}/leadsleads:writeAniq rozilik va aloqa tanlovi bilan canonical lid yaratish
GET/sites/{site_id}/leads/{lead_id}leads:readBitta lidni olish
PATCH/sites/{site_id}/leads/{lead_id}leads:writeLidni yangilash, qualify qilish yoki aloqa siyosatini o‘zgartirish
POST/sites/{site_id}/leads/{lead_id}/acceptleads:writeLidni imkoniyat pipelineʼiga qabul qilish
GET/sites/{site_id}/analyticsanalytics:readTahlil hodisalarini ro‘yxatlash
GET/sites/{site_id}/usageusage:readO‘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#

MetodYo‘lRuxsatVazifasi
GET / POST/sites/{site_id}/pipeline/stagespipeline:read / pipeline:writeBosqichlarni ko‘rish yoki sozlash
GET / POST/sites/{site_id}/pipeline/accountspipeline:read / pipeline:writeBiznes hisoblarini ko‘rish yoki yaratish
GET/sites/{site_id}/pipeline/accounts/{account_id}pipeline:readBiznes hisobini olish
GET / POST/sites/{site_id}/pipeline/opportunitiespipeline:read / pipeline:writeImkoniyatlarni ko‘rish yoki yaratish
GET / PATCH/sites/{site_id}/pipeline/opportunities/{opportunity_id}pipeline:read / pipeline:writeFaollikni o‘qish yoki masʼul, qiymat, bosqich, keyingi amal va inson javobini yangilash
POST/sites/{site_id}/pipeline/outcomespipeline:writeCRM manbali won/lost natijani idempotent import qilish
GET/sites/{site_id}/pipeline/sync-recordspipeline:readSinxronlash holati, urinish va xatolarni ko‘rish
POST/sites/{site_id}/pipeline/sync-records/{sync_record_id}/retrypipeline:writeSaqlangan 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#

MetodYo‘lRuxsatVazifasi
GET/sites/{site_id}/connectorsconnectors:readSirlarni bermasdan konnektor holatini ro‘yxatlash
POST/sites/{site_id}/connectorsconnectors:writeKanal konnektorini yaratish/almashtirish va webhookini sozlash
PATCH/sites/{site_id}/connectors/{connector_id}connectors:writestatus yoki reply_with_voiceni o‘rnatish
DELETE/sites/{site_id}/connectors/{connector_id}connectors:writeKonnektorni provayderdan uzish va olib tashlash
GET/sites/{site_id}/domainsdomains:readOlib tashlangan — 409. Maxsus domenlar taklif etilmaydi
POST/sites/{site_id}/domainsdomains:writeOlib tashlangan — 409
PATCH/sites/{site_id}/domains/{domain_id}domains:writeOlib tashlangan — 409
POST/sites/{site_id}/domains/{domain_id}/verifydomains:writeOlib tashlangan — 409
DELETE/sites/{site_id}/domains/{domain_id}domains:writeOlib 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#

MetodYo‘lRuxsatVazifasi
GET/sites/{site_id}/broadcastsbroadcasts:readOmmaviy xabarlarni ro‘yxatlash
POST/sites/{site_id}/broadcastsbroadcasts:writeKakao ommaviy xabar qoralamasini yaratish
POST/sites/{site_id}/broadcasts/{broadcast_id}/sendbroadcasts:writeMavjud qoralamani navbatga qo‘yish; 202 qaytaradi
GET/sites/{site_id}/notificationsnotifications:readEga 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/productsmonetization:readSayt mahsulotlarini ro‘yxatlash
POST/sites/{site_id}/monetization/productsmonetization:writeKirish, maslahat, choychaqa yoki raqamli mahsulot yaratish
PATCH/sites/{site_id}/monetization/products/{product_id}monetization:writeMahsulot maydonlari va faol holatini yangilash
DELETE/sites/{site_id}/monetization/products/{product_id}monetization:writeMahsulotni 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#

MetodYo‘lRuxsatVazifasi
GET/webhook-endpointswebhooks:readImzolash sirisiz endpoint holatini ro‘yxatlash
POST/webhook-endpointswebhooks:writeOchiq HTTPS URLʼni ro‘yxatdan o‘tkazish va imzolash sirini bir marta ko‘rsatish
DELETE/webhook-endpoints/{endpoint_id}webhooks:writeEndpointni 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: true bilan qaytaradi.
  • Bir xil kalit boshqa kiritma bilan: 409 conflict qaytaradi.
  • Birinchi so‘rov ishlayotganida bir xil kalit: 409 conflict va Retry-After: 2 qaytaradi.

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.