ثبت یک برنامهٔ بیرونی
هدف
یک سامانهٔ بیرونی (یک یکپارچه‌سازی، سرویس یا میان‌افزار) را ثبت کنید تا بتواند با اعتبارنامه‌های خودش APIهای Parsware را فراخوانی کند.
پیش‌نیازها
- با نقش مدیر پلتفرم وارد مرکز کنترل مدیریت شده‌اید.
- می‌دانید سامانهٔ بیرونی به کدام دامنه‌های دسترسی نیاز دارد (برای نمونه، دسترسی خواندن به داده‌های برنامه).
گام‌ها
- صفحهٔ ثبت برنامه را از ناوبری کناری باز کنید.
- یک نام برنامه وارد کنید که سامانهٔ بیرونی را مشخص کند.
- دامنه‌های دسترسی مورد نیاز برنامه را از فهرست انتخاب کنید. هر دامنهٔ دسترسی نوع مشخصی از دسترسی را اعطا می‌کند.
- در صورت نیاز، نقش‌های امنیتی برنامه را انتخاب کنید. خالی گذاشتن این بخش یعنی کمترین دسترسی: برنامه می‌تواند پلتفرم را فراخوانی کند و به هیچ رکوردی دست نزند. اسکریپت یک Custom API به‌عنوان خودِ برنامه و زیر همین نقش‌ها اجرا می‌شود — پس برنامه‌ای که اسکریپت‌هایش رکورد می‌خوانند یا می‌نویسند دقیقاً همان یک نقشی را لازم دارد که این کار را مجاز است، و به آن نقش فقط در محیط‌هایی که برنامه به آن‌ها خدمت می‌دهد مجوز بدهید.
- گزینهٔ ثبت برنامه را انتخاب کنید.
- یک پنل، Client ID و Client secret جدید را نشان می‌دهد. همین حالا مقدار client secret را کپی کنید — این مقدار فقط یک بار نمایش داده می‌شود و دوباره قابل بازیابی نیست.
پشت صحنه چه اتفاقی می‌افتد
برنامهٔ بیرونی به یک کلاینت ثبت‌شدهٔ API تبدیل می‌شود. این برنامه با client id و client secret خود احراز هویت می‌کند تا یک توکن دسترسی کوتاه‌عمر بگیرد و سپس با همان توکن APIهای Parsware را فراخوانی می‌کند. دامنهٔ توکن دقیقاً به همان دسترسی‌هایی محدود است که شما اعطا کرده‌اید.
عیب‌یابی
- «Scope … can only be granted by the platform operator.» —
parsware.provisionوparsware.portals.serveمتعلق به سرورهای خودِ گردانندهٔ پلتفرم (وب‌سایت و میزبان پورتال) هستند و در فهرست شما نیستند. هیچ یک از برنامه‌های شما به آن‌ها نیاز ندارد. - برنامهٔ ابطال‌شده هنوز مدتی پاسخ می‌گرفت. ابطال بلافاصله جلوی گرفتن توکن تازه را می‌گیرد، اما توکنی که از قبل دارد را هر سرویس خودش بررسی می‌کند و تا انقضا، حداکثر یک ساعت، معتبر می‌ماند. برای قطع فوری، مجوزهای نقش آن را هم در آن محیط بردارید: این مجوزها در هر فراخوانی بررسی می‌شوند.
- «Scope … is not a known platform scope.» — یکی از دامنه‌های دسترسی درخواست‌شده در فهرست رسمی نیست. فقط دامنه‌های دسترسی موجود در فهرست نمایش‌داده‌شده را انتخاب کنید.
- «At least one scope must be granted.» — پیش از ثبت، دست‌کم یک دامنهٔ دسترسی انتخاب کنید.
- مقدار client secret را گم کرده‌اید — این مقدار قابل بازیابی نیست. ثبت برنامه را باطل کنید و برنامه را دوباره ثبت کنید تا یک secret تازه بگیرید.
سناریوهای مرتبط
- باطل کردن یک برنامهٔ بیرونی.