Hisobni boshqarish API

Tez boshlash

Hisob sozlamalari → API tokenlar bo‘limida token yarating. Tayyor huquqlar to‘plami, kerakli resurslar va amal qilish muddatini tanlang. Sir faqat bir marta ko‘rsatiladi. Uni integratsiyangizning sirlar omborida saqlang.

# MAILCORE_MANAGEMENT_TOKEN is supplied by your secret store.
curl --fail-with-body https://mailcore.uz/api/management/v1/token/verify \
  --header "Authorization: Bearer $MAILCORE_MANAGEMENT_TOKEN" \
  --header 'Accept: application/json'

curl --fail-with-body https://mailcore.uz/api/management/v1 \
  --header "Authorization: Bearer $MAILCORE_MANAGEMENT_TOKEN"

Boshqaruv kaliti mcm_ bilan boshlanadi. mck_ yuborish kalitlari alohida Email API uchun ishlaydi. Xat yuborish uchun loyiha va oqimga email_keys.write huquqi bilan yuborish kaliti yarating.

AI agentga OpenAPI havolasini va MAILCORE_MANAGEMENT_TOKEN muhit o‘zgaruvchisi nomini bering. Agent avval token va ruxsat etilgan resurslarni tekshiradi, so‘ng siz ruxsat bergan o‘zgarishlarni bajaradi. Kalitni topshiriq matniga kiritmang.

Ruxsat va resurslar

• Hisob: token yaratuvchisi hozir kira oladigan barcha tashkilot va resurslar.
• Tashkilotlar: faqat tanlangan tashkilotlar va ulardagi ruxsat etilgan amallar.
• Domenlar: faqat tanlangan domenlar, ularning pochtasi va bog‘liq Email API loyihalari.
• Loyihalar: faqat tanlangan Email API loyihalari, ochiq eaw_… ID orqali.

Token huquqlari har doim yaratuvchining joriy huquqlari bilan cheklanadi. A’zolik olib tashlansa, rol pasaysa, token bekor qilinsa yoki muddati tugasa, tegishli kirish to‘xtaydi. To‘lov, jamoa, yuborish kalitlari va webhook uchun huquqlar alohida. Domen va loyiha tokeni butun tashkilot moliyasiga kirish bermaydi.

Amallar uchun huquqlar

O‘qish resurslar va ro‘yxatlarni olishga ruxsat beradi. O‘zgartirish o‘qish hamda mavjud yaratish va yangilash amallarini o‘z ichiga oladi. Har bir metod kerakli huquqni ko‘rsatadi; domen huquqi o‘z-o‘zidan pochta qutilari yoki yuborish kalitlariga ruxsat bermaydi.

account · organizations · team · domains · mailboxes · aliases
email_projects · email_activity · email_keys · webhooks · billing · audit

<group>.read / <group>.write

Amallar jurnali faqat o‘qish uchun: audit.read. Token orqali hodisalarni o‘zgartirish yoki o‘chirish mumkin emas.

Domen va pochtani ulash

• Tashkilot yarating yoki tanlang va domen qo‘shing. Javobda domen va ulanish buyurtmasi ID’lari keladi.
• Tashkilot, domen va buyurtma ID’lari bilan ulanishni oling. DNS provayderingizda berilgan TXT yozuvni qo‘shing va egalikni tekshiring.
• Tarif va saqlash parametrlarini tanlang, to‘lov havolasini oling va to‘lov holatini tekshiring. Moliyaviy amallar uchun billing.write kerak.
• Pochtani yaratishni boshlang va amal hamda buyurtma holatini kuzating. Kerakli MX/SPF/DKIM/DMARC yozuvlarini qo‘shing va yakuniy DNS tekshiruvini bajaring.

API kerakli DNS yozuvlarini beradi va tekshiradi. Yozuvlar DNS provayderida o‘zgartiriladi. Bank kartasi va bank kodi xavfsiz to‘lov sahifasida tasdiqlanadi; API kerakli amal va havolani qaytaradi.

Email API loyihalari

Tasdiqlangan tashkilot domenida loyiha yarating. Marketingni alohida yoqing, DNS’ni sozlang, tekshiruvni boshlang va yuborish kalitlari hamda webhook yarating. Xatlar, paketlar va navbat faoliyati uchun email_activity.read kerak; transactional va marketing oqimlari alohida.

Paketlar, narxlar va qolgan xatlar uchun billing.read bilan GET /organizations/{organization_id}/email-api/billing ni chaqiring. Bu metod faqat moliyaviy ma’lumotlarni qaytaradi. Paket sotib olish uchun billing.write kerak.

Takroriy so‘rovlar va fon amallari

Har bir POST uchun Idempotency-Key kerak. Yangi amal uchun yangi qiymat ishlating; tarmoq uzilishidan so‘ng ayni so‘rovni ayni qiymat bilan takrorlang. Ayni kalit bilan boshqa ma’lumot yuborish ziddiyatga olib keladi. Sir yaratishni takrorlashdan oldin natijani tekshiring: yo‘qolgan sir qayta ko‘rsatilmaydi.

Pochta va resurs o‘zgarishlari cheklangan navbatda bajariladi. Muvaffaqiyatli HTTP javobi amal tugaganini emas, navbatga olinganini bildirishi mumkin. Qaytgan amal holatini kuzating. Boshlanmagan amal bajarilishidan oldin token va yaratuvchi huquqlari qayta tekshiriladi. Tokenni bekor qilish tugagan o‘zgarishni ortga qaytarmaydi.

Retry-After ni hisobga oling, vaqtinchalik xatolarni oshib boruvchi tanaffus bilan takrorlang va bir nechta tez-tez so‘rov siklini ishlatmang. Odatiy limit: token uchun daqiqasiga 120, hisob uchun 600 ta so‘rovgacha. Xat yuborishda alohida limit va navbat bor.

Alohida pochta qutisi yoki taxallus amali holati: GET /organizations/{organization_id}/domains/{domain_id}/operations/{operation_id}. Oraliq holatlar — queued, leased, retry; yakunlangan — done, xato — dead. Faqat javobda canRetry ruxsat berilsa takrorlang; parol amali uchun yangi parol kerak bo‘lishi mumkin.

Xatolar va jurnal

Javoblarda requestId bor; X-Request-Id sarlavhasi yordam xizmatiga so‘rovni topishga yordam beradi. 401 — kalit yaroqsiz; 403 — amal yoki resursga ruxsat yo‘q; 409 — holat yoki versiya ziddiyati; 422 — maydonlar xato; 429 — so‘rov limiti. Bog‘liq xizmatning vaqtinchalik xatosi alohida bildiriladi. O‘zgartirishdan oldin resursning joriy versiyasini oling.

Tashkilot amallari jurnali uchun audit.read kerak. Yordam xizmatiga so‘rov ID’si, xato kodi va vaqtini bering. Token, parol, bank kodi yoki sirli so‘rov tanasini yubormang.

Metodlar ma’lumotnomasi

Asosiy manzil: https://mailcore.uz/api/management/v1. Resurs ID’lari aniq beriladi; API brauzerda tanlangan tashkilotni o‘zgartirmaydi. Jadvalda mavjud metodlar va kerakli huquqlar bor. So‘rov maydonlari va qiymatlar OpenAPI’da berilgan.