API kalitlari
API kaliti sayt, ilova yoki serveringizga interfeysga kirmasdan loyiha bilan ishlash imkonini beradi: hodisalarni yuborish, profillarni oʻqish, segmentlar, zanjirlar va kampaniyalarni boshqarish. Kalitlar «Sozlamalar» → «API kalitlari» boʻlimida yaratiladi va qaytarib olinadi.
Boʻlimni «Egasi», «Administrator» va «Menejer» koʻradi. Kalitlarni «Egasi» va «Administrator» yaratishi va qaytarib olishi mumkin.
Kalit turlari
| Write | Secret | |
|---|---|---|
| Boshlanishi | cdp_wk_ |
cdp_sk_ |
| Nimaga ruxsat beradi | faqat hodisalarni yuborishga | hodisalarni yuborish va tanlangan ruxsatlar boʻyicha loyihadagi amallarga |
| Qayerda ishlatiladi | sayt kodi, mobil ilova, server | faqat Sizning serveringiz |
| Begonalarga koʻrsatish mumkinmi | ha, u sayt sahifalari kodida koʻrinadi | yoʻq, maxfiy saqlang |
| Soʻrovlar limiti | daqiqasiga 6000 | daqiqasiga 1200 (sukut boʻyicha) |
Write kaliti tabiatan ochiq: u saytning har bir sahifasi kodida turadi. U bilan faqat hodisalarni yuborish mumkin, shuning uchun uning sizib chiqishi maʼlumotlarga kirish imkonini bermaydi. Begona sayt Sizning nomingizdan hodisalar yubora olmasligi uchun «Sayt» boʻlimida kalit qabul qilinadigan domenlarni koʻrsatish mumkin — qarang: Saytni ulash.
Secret kaliti loyiha maʼlumotlariga server orqali kirish huquqini beradi. Uni hech qachon sahifalar kodiga, mobil ilovalarga va ochiq repozitoriylarga qoʻymang.
Kalitni qanday yaratish kerak
- «API kalitlari» boʻlimini oching.
- «Yangi kalit» kartasida «Nomi»ni kiriting — keyinchalik u orqali kalit qayerda ishlatilayotganini tushunasiz, masalan, «Sayt» yoki «Internet-doʻkon serveri».
- «Turi»ni tanlang: Write yoki Secret.
- Secret uchun «Kalit ruxsatlari»ni belgilang — faqat integratsiyaga haqiqatan kerak boʻlganlarini.
- «Kalit yaratish» tugmasini bosing.
Yaratilgandan soʻng darhol sahifaning yuqori qismida toʻliq kalit paydo boʻladi. «Nusxalash» tugmasini bosing va uni, masalan, parollar menejerida yoki server muhit oʻzgaruvchilarida saqlang. Maxfiy kalit faqat bir marta koʻrsatiladi: biz faqat uning izini saqlaymiz, kalitni tiklab boʻlmaydi. Agar uni yoʻqotgan boʻlsangiz, yangisini yarating va eskisini qaytarib oling.
Sayt uchun Write kalitini toʻgʻridan-toʻgʻri «Sayt» boʻlimida yaratish qulayroq: u yerda u darhol oʻrnatish kodiga qoʻyiladi va istalgan vaqtda mavjud boʻladi — qarang: Saytni ulash.
Kalitlar jadvalida nomi, uni kim va qachon yaratgani, turi, kalit boshlanishi (masalan, cdp_sk_a1b2…), ruxsatlar soni va oxirgi foydalanish vaqti koʻrinadi.
Maxfiy kalit ruxsatlari
Kalitga faqat oʻzingizda bor ruxsatlarni berish mumkin. Ruxsatlar butun loyihaga amal qiladi — kalitni alohida zanjirlar yoki segmentlar bilan cheklab boʻlmaydi.
| Ruxsat | Nimaga kirish imkonini beradi |
|---|---|
| Profillarni oʻqish | identifikator boʻyicha profil va uning hodisalari |
| Maskalanmagan shaxsiy maʼlumotlar | email, telefon va boshqa shaxsiy maʼlumotlar ochiq koʻrinishda; bu ruxsatsiz ular maskalanadi |
| Profillar va roziliklarni oʻzgartirish | xabarlarga roziliklar, Telegramni bogʻlash |
| Profillarni oʻchirish (GDPR) | xaridor soʻroviga koʻra profilni oʻchirish |
| Hodisalar va xususiyatlar katalogi | hodisalar va profil xossalari roʻyxati |
| Segmentlarni oʻqish / oʻzgartirish | segmentlarni koʻrish, yaratish, oʻzgartirish, oʻchirish va qayta hisoblash |
| Zanjirlar va hisobotlarni oʻqish; qoralamalarni oʻzgartirish va ishtirokchilarni kiritish; zanjirlarni eʼlon qilish, pauza qilish va arxivlash | zanjirlar bilan ishlash |
| Kampaniyalar va hisobotlarni oʻqish; yaratish va oʻzgartirish; ishga tushirish, pauza qilish va bekor qilish | kampaniyalar bilan ishlash |
| Mahsulotlar katalogi va tavsiyalarni oʻqish; mahsulotlarni yuklash va oʻchirish | mahsulotlar va tavsiyalar |
| Analitika | hisobotlar |
Misol: CRM dan VIP xaridorlarni sinxronlash uchun kalitga «Segmentlarni oʻqish» va «Segmentlarni oʻzgartirish» ruxsatlari yetarli.
Maxfiy kalit orqali bajarilgan barcha amallar loyihaning audit jurnaliga kalit nomidan yoziladi — qarang: Loyiha sozlamalari, tarif va audit.
Kalitni qanday qaytarib olish kerak
- Jadvalda kalitni toping va «Qaytarib olish» tugmasini bosing.
- Amalni tasdiqlang.
Ushbu kalit bilan yuborilgan soʻrovlar darhol ishlamay qoladi (401 javobi). Qaytarib olingan kalit tarixi koʻrinib turishi uchun roʻyxatda «Qaytarib olingan» belgisi bilan qoladi. Uni qaytarib boʻlmaydi — kerak boʻlsa, yangisini yarating.
Agar kalit begonalar qoʻliga tushgan boʻlishi mumkin boʻlsa, unga kirish huquqi boʻlgan xodim ishdan ketgan boʻlsa yoki integratsiya endi ishlatilmasa, kalitni darhol qaytarib oling.
Nimalarni bilish muhim
- Limitlar. Soʻrovlar limiti yoki tarifning oylik hodisalar kvotasi oshib ketganda API
429bilan javob beradi. Yuborishni bir tekis taqsimlang va soʻrovni pauza bilan takrorlang. - Kalitni xavfsiz almashtirish. Yangi kalit yarating, uni serverda yangilang, soʻrovlar ketayotganiga ishonch hosil qiling («Oxirgi foydalanish» maydoni) va shundan keyingina eskisini qaytarib oling.
- Har bir integratsiya uchun alohida kalit. Shunda audit jurnalida kim nima qilgani koʻrinadi, sizib chiqqanda esa bitta kalitni qaytarib olish kifoya.
- Server orqali hodisalarni qanday yuborish va API ni chaqirish haqida Server orqali integratsiya maqolasida oʻqing.