Hamkorlar uchun OAuth ilovalari
Hamkorga tegishli OAuth ilovasi bir nechta Planfix hisobiga ulanadigan integratsiya uchun mo‘ljallangan. Barcha mijoz hisoblari uchun bir xil ilova hisob ma’lumotlaridan foydalaniladi, har bir hisob esa ulanishga ruxsat berish yoki bermaslikni alohida boshqaradi va har bir foydalanuvchi ulanishga o‘zi rozilik beradi.
Agar integratsiya faqat bitta hisob uchun mo‘ljallangan bo‘lsa, hisobga tegishli ilova yaratish osonroq.
Ilova yaratish
- Hamkor hisobingizni oching.
- OAuth ilovalari bo‘limiga o‘ting.
- Ilova yaratish bandini tanlang.
- Foydalanuvchilar va administratorlarga ko‘rinadigan nom va tavsifni kiriting.
- OAuth mijoz turini tanlang.
- Qayta yo‘naltirish URI manzillarini qo‘shing.
- REST API uchun zarur bo‘lgan eng kam ruxsatlar doirasini tanlang.
- Ilovani saqlang va uning hisob ma’lumotlarini nusxalang.
Yangi ilova maxfiy bo‘ladi va u ulanadigan har bir hisobda alohida tasdiqlanishi kerak.
OAuth mijoz turi
| Tur | Mo‘ljallangan ilovalar | Hisob ma’lumotlari |
|---|---|---|
| Ommaviy | Mobil, kompyuter va brauzer ilovalari hamda mahalliy MCP mijozlari. | Faqat client_id. Mijoz siri mavjud emas; PKCE S256 majburiy.
|
| Maxfiy | Sirni foydalanuvchi qurilmasi va mijoz tomonidagi koddan tashqarida saqlash mumkin bo‘lgan server tomonidagi ilovalar. | client_id va client_secret.
|
OAuth mijoz turi ilovaning chop etilgan yoki chop etilmaganligidan alohida belgilanadi. Masalan, maxfiy mobil ilova siri bo‘lmagan ommaviy OAuth mijozidir.
Qayta yo‘naltirish URI manzillari
Tizimga kirgandan so‘ng Planfix foydalanuvchini qaytarishi mumkin bo‘lgan barcha URL manzillarini ko‘rsating.
- Veb-xizmat uchun
httpsdan foydalaning. httpga faqatlocalhostva127.0.0.1kabi loopback manzillar uchun ruxsat beriladi.- Mijoz loopback manzili uchun dinamik portdan foydalanishi mumkin, ammo sxema, xost, yo‘l va so‘rov mos kelishi kerak.
- Siz nazorat qilmaydigan URL manzillar, URL fragmentlari yoki qayta yo‘naltirish URI manzillari uchun joker belgilardan foydalanmang.
Ruxsatlar doirasi
Ruxsatlar doirasi ilovaning maksimal ruxsatlarini belgilaydi. Faqat REST API ruxsatlari ro‘yxatidan kerakli kirish darajalarini so‘rang.
Ilova ruxsatlari foydalanuvchining odatiy ruxsatlarini almashtirmaydi. Ruxsat berilgan taqdirda ham ilova faqat shu foydalanuvchi foydalanishi mumkin bo‘lgan ma’lumotlar bilan ishlay oladi.
Qayta yo‘naltirish URI manzillari yoki ruxsatlar doirasini o‘zgartirish yangi tasdiqlash versiyasini yaratadi. Avval ulangan hisoblar yangi versiyani ko‘rib chiqib, tasdiqlashi, foydalanuvchilar esa qaytadan ulanishi kerak.
Mijoz hisobini ulash
Hamkorga tegishli maxfiy ilova har bir hisobda administrator tomonidan alohida tasdiqlanishi kerak.
- Hamkor hisobingizda ilovani oching.
- Tasdiqlash havolasi maydoniga mijoz hisobining nomini kiriting.
- Yaratilgan havolani nusxalang va shu hisob administratoriga yuboring.
- Administratordan egasini, qayta yo‘naltirish URI manzillarini va ruxsatlar doirasini tekshirib, ilovani tasdiqlashini so‘rang.
- Tasdiqlangandan so‘ng, hisobdagi foydalanuvchilar OAuth avtorizatsiyasini yakunlashi mumkin. Har bir foydalanuvchi o‘z nomidan alohida rozilik beradi.
Havola Hisobni boshqarish → API → OAuth va MCP ilovalari bo‘limini ochib, so‘ralgan ilovani ko‘rsatadi.
Ilovani o‘zi ham ulayotgan administrator Tasdiqlash va ulash bandini tanlashi mumkin.
Maxfiy va chop etilgan ilovalar
| Holat | Hisobga qanday ruxsat beriladi |
|---|---|
| Maxfiy | Har bir hisob administratorining alohida tasdig‘i doimo talab qilinadi. |
| Chop etilgan | Hisob siyosati Chop etilgan ilovalarga ruxsat berish bo‘lsa, alohida tasdiqsiz foydalanish mumkin. Siyosat Faqat tasdiqlangan ilovalar bo‘lsa, baribir tasdiqlash talab qilinadi. |
Chop etish Planfix tomonidan alohida ko‘rib chiqiladi. Ilovani yuborishdan oldin aniq nom va tavsif, minimal ruxsatlar doirasi, ishlaydigan qayta yo‘naltirish URI manzillari hamda integratsiyani ulash va uzish bo‘yicha foydalanuvchi hujjatlarini tayyorlang. Chop etish tartibi haqida Planfix qo‘llab-quvvatlash xizmatiga murojaat qiling.
Ulanish manzillari
Foydalanuvchi hisobi joylashgan Planfix mahsuloti uchun global OAuth yakuniy nuqtalaridan foydalaning:
| Maqsad | Manzil |
|---|---|
| Avtorizatsiya | -{R|https://auth.planfix.com/oauth/authorize}-
|
| Token | -{R|https://auth.planfix.com/oauth/token}-
|
| Foydalanuvchi ma’lumotlari | -{R|https://auth.planfix.com/oauth/userinfo}-
|
| MCP | -{R|https://mcp.planfix.com/mcp}-
|
Global URL manziliga hisob nomini qo‘shmang. Foydalanuvchi hisobni Planfix sahifasida tanlaydi. resource, PKCE, tokenni yangilash va bekor qilishni o‘z ichiga olgan to‘liq protokol Ilovalar uchun OAuth 2.0 da bayon qilingan.
Ilovani boshqarish
Hamkor quyidagilarni amalga oshirishi mumkin:
- nom va tavsifni tahrirlash;
- qayta yo‘naltirish URI manzillari va ruxsatlar doirasini o‘zgartirish;
- ilovani o‘chirib qo‘yish va qayta yoqish;
- maxfiy ilovaning mijoz sirini almashtirish;
- muayyan hisob uchun ilovani tasdiqlash havolasini yaratish.
Sir almashtirilgandan so‘ng eski mijoz siri darhol ishlamay qoladi. Integratsiya serveridagi sirni yangilang va uni foydalanuvchilarga hech qachon yubormang.
Ilovani o‘chirib qo‘yish barcha hisoblarda OAuth avtorizatsiyasini va ilova chiqargan tokenlarni bloklaydi. Bu amal ilovadan foydalanayotgan barcha mijozlarga ta’sir qiladi.
Ishga tushirishdan oldingi tavsiyalar
- Authorization Code with PKCE S256 dan foydalaning va
stateqiymatini tekshiring. - Faqat kerakli ruxsatlar doirasini so‘rang.
- Tizimga kirgandan so‘ng foydalanuvchiga tanlangan hisobni ko‘rsating.
- Yangilash tokenining almashtirilishini hisobga oling: token muvaffaqiyatli yangilangach, avvalgi yangilash tokeni yaroqsiz bo‘ladi.
- Tokenlar, avtorizatsiya kodlari,
code_verifieryoki mijoz sirlarini jurnalga yozmang. - Foydalanuvchilar integratsiyani qanday uzishi va ma’lumotlarini o‘chirishni qanday so‘rashi mumkinligini hujjatlashtiring.
- Tasdiqni bekor qilish, ilovani o‘chirib qo‘yish va qayta ulanish holatlarini sinab ko‘ring.