کلیدهای API

کلید API راهی است که بک‌اند شما با آن ثابت می‌کند خود شماست. کلیدهای آزمایشی در سندباکس کار می‌کنند؛ کلیدهای زنده متقاضیان واقعی را پردازش می‌کنند. هر کلید به یک محیط تعلق دارد و در محیط دیگر قابل استفاده نیست.

این صفحه برای مالکان و توسعه‌دهندگان است. اگر تیم شما مهندسی ندارد، احتمالاً هرگز آن را باز نمی‌کنید.

ساختن کلید

کلید را بر اساس کاری که قرار است انجام دهد نام‌گذاری کنید، با کدی از اپلیکیشن احراز هویت خود تأیید کنید، و راز کلید یک بار نمایش داده می‌شود.

در نمای ترکیبی همهٔ محیط‌ها، پنجره شما را وادار می‌کند انتخاب کنید کلید به کدام محیط تعلق دارد، چون چیزی وجود ندارد که بتوان آن را از رویش حدس زد.

خواندن و نوشتن، یا فقط خواندن

پنجرهٔ ساخت همچنین می‌پرسد کلید اجازهٔ انجام چه کاری را دارد. خواندن و نوشتن پیش‌فرض است و همهٔ کلیدهایی که از قبل دارید همین‌اند. فقط خواندن کلیدی می‌سازد که هر نوشتنی از آن رد می‌شود، هر اجازهٔ دیگری که داشته باشد، برای تمام عمر کلید.

فقط خواندن چیزی دربارهٔ اینکه کلید چه مقدار می‌تواند بخواند نمی‌گوید. آن پرسش بعدی پنجره است و این دو از هم مستقل‌اند: کلید فقط‌خواندنی را می‌توان به نتیجه‌ها محدود کرد و کلید خواندن و نوشتن می‌تواند همه‌چیز را بخواند.

از فقط خواندن برای هر چیزی استفاده کنید که داده‌های شما را بدون تغییرشان می‌بیند: یک گزارش، یک داشبورد داخلی، یک خروجی شبانه به سامانه‌های خودتان، ابزاری که تیم پشتیبانی شما برای پیدا کردن مشتریان استفاده می‌کند. آن را به پیمانکاری بدهید که یکپارچه‌سازی می‌سازد، و او نمی‌تواند تصادفاً دربارهٔ پرونده‌ای تصمیم بگیرد یا تنظیمی را تغییر دهد.

کلیدهای فقط‌خواندنی در فهرست با همین نشان مشخص شده‌اند، تا با یک نگاه ببینید کدام اعتبارنامه‌های شما می‌توانند چیزی را تغییر دهند. کلیدهای خواندن و نوشتن نشانی ندارند، چون حالت عادی همین است.

این کلید چه چیزی را می‌تواند بخواند

پرسش سوم پنجرهٔ ساخت تعیین می‌کند کلید چه مقدار از یک احراز هویت را می‌تواند ببیند.

فقط نتیجه پیش‌فرض است و همهٔ کلیدهایی که از قبل دارید همین‌اند. وضعیت، حکم، کدهای دلیل و نتیجهٔ هر بررسی را می‌خواند. خود شخص را نمی‌تواند بخواند: نه نام، نه تاریخ تولد، نه شمارهٔ مدرک، نه تصویری.

داده کامل همهٔ این‌ها را اضافه می‌کند: هویتی که از مدرک خوانده‌ایم، از جمله املای نام به خط اصلی و تاریخ‌ها دقیقاً همان‌طور که روی کارت چاپ شده‌اند، و تصویرهای گرفته‌شده از مدرک و سلفی. یکپارچه‌سازی شما در هر درخواست، با include=applicant,documents روی یک احراز هویت، آن را می‌خواهد، پس کلیدی که این دسترسی را دارد تا وقتی بیشتر نخواهید همچنان فقط نتیجهٔ ساده را برمی‌گرداند.

داده کامل را وقتی انتخاب کنید که چیزی از سامانه‌های شما به خود شخص نیاز دارد و نه فقط به پاسخ: کارت مشتری در ابزار پشتیبانی خودتان، همگام‌سازی شبانه با سامانه‌هایتان، یک پروندهٔ انطباق. آن را با فقط خواندن همراه کنید تا آن سامانه همه‌چیز را ببیند و هیچ چیز را تغییر ندهد.

کلیدهایی که داده کامل دارند در فهرست با نشان هویت مشخص شده‌اند، تا با یک نگاه ببینید کدام اعتبارنامه‌های شما می‌توانند یک شخص واقعی را بخوانند.

کلیدهایی که ما برای شما صادر می‌کنیم

یک دسترسی هنوز هرگز به‌طور پیش‌فرض داده نمی‌شود و نمی‌توان آن را به کلیدی که خودتان می‌سازید اضافه کرد. از ما بخواهید تا آن را روی حساب شما صادر کنیم؛ این کلید مثل هر کلید دیگری در همین فهرست ظاهر می‌شود.

بک‌آفیس کلیدی را مشخص می‌کند که می‌تواند جلسه‌ای را به نمایندگی از یکی از افراد خود شما باز کند، که اتصال پنل مدیریت خودتان بر پایهٔ آن کار می‌کند. کلید در را باز می‌کند؛ اینکه شخص آن سوی در واقعاً چه کاری می‌تواند بکند را جایگاه او در صفحهٔ تیم تعیین می‌کند و هیچ چیز دربارهٔ کلید در آن نقشی ندارد. آن را با فقط خواندن همراه کنید تا کارکنان آن‌ها بتوانند صف شما را پیش ببرند بدون اینکه بتوانند دربارهٔ چیزی تصمیم بگیرند.

چرخش و لغو

چرخش برای همان کلید یک راز تازه صادر می‌کند. لغو کلید را بلافاصله از کار می‌اندازد و هر یکپارچه‌سازی‌ای که هنوز از آن استفاده می‌کند از درخواست بعدی شروع به خطا دادن می‌کند. هیچ‌کدام قابل برگشت نیستند و هر دو ابتدا کد اپلیکیشن احراز هویت شما را می‌خواهند، چون کلید یعنی دسترسی به محیط عملیاتی در قالب یک رشته.

پیام تأیید برای کلید زنده همین را صراحتاً می‌گوید. پیش از موافقت آن را بخوانید.

آخرین استفاده، و اینکه کلید چه کرده است

فهرست نشان می‌دهد هر کلید آخرین بار کی استفاده شده، یعنی جدیدترین درخواست API که در محیطی که در حال دیدن آن هستید برای آن ثبت کرده‌ایم. درخواست‌های کلید زنده در زنده ثبت می‌شوند، پس اگر ستون خالی به نظر می‌رسد، پیش از اینکه نتیجه بگیرید کلید بیکار است کلید محیط را بررسی کنید.

کلیدی را انتخاب کنید تا پنلی ترافیک اخیر آن را نشان دهد. این داده از گزارش‌های یکپارچه‌سازی می‌آید، پس نقشی که به گزارش‌ها دسترسی ندارد کلید را می‌بیند ولی تاریخچه‌اش را نه، و پنل به جای نشان دادن نموداری خالی همین را می‌گوید.

اگر کلیدی اصلاً درخواستی نداشته، پنل این را هم می‌گوید. هر درخواست احراز هویت‌شده‌ای که بک‌اند شما با آن امضا کند ظرف چند ثانیه ظاهر می‌شود.

کارهای نگه‌داری که ارزش انجام دارند

به هر یکپارچه‌سازی کلید خودش را بدهید و یک کلید را مشترک استفاده نکنید، تا لغو یک اعتبارنامهٔ لورفته همهٔ آنچه اجرا می‌کنید را از کار نیندازد. کلیدها را به نام سامانه‌ای که آن‌ها را نگه می‌دارد نام‌گذاری کنید. و به یاد داشته باشید که ساختن کلید آن را مشترک هیچ چیزی نمی‌کند: احراز هویت‌هایی که با کلید تازه ساخته می‌شوند فقط وقتی به نقاط پایانی شما می‌رسند که یک نقطهٔ پایانی وب‌هوک برای دریافت آن‌ها تنظیم شده باشد، که صفحهٔ Webhook مستقیماً دربارهٔ آن هشدار می‌دهد.