ایجاد و مدیریت کلیدهای API

کلیدهای API یکپارچه‌سازی‌های شما را در برابر REST API سیستم USystems احراز هویت می‌کنند، بنابراین باید با همان دقتی که یک رمز عبور را نگه می‌دارید با آن‌ها رفتار کنید. تمام مدیریت کلیدها از طریق Settings > Developer انجام می‌شود.

۱. Settings > Developer را باز کنید و New API Key را انتخاب کنید. ۲. به کلید یک نام توصیفی بدهید، مانند «billing-sync-production»، تا بعداً بتوانید هدف آن را شناسایی کنید. ۳. دامنه‌های (scopes) موردنیاز کلید را انتخاب کنید — دسترسی فقط-خواندنی برای بیشتر یکپارچه‌سازی‌های گزارش‌گیری کافی است، در حالی که دسترسی نوشتن باید فقط به ماژول‌های خاصی که به آن نیاز دارند محدود شود. ۴. بلافاصله کلید را کپی کنید؛ به دلایل امنیتی، مقدار کامل آن فقط یک‌بار نمایش داده می‌شود. ۵. کلید را در یک مدیر اسرار (secrets manager) یا متغیر محیطی ذخیره کنید، هرگز در کد منبع یا یک سند مشترک.

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