دریافت و ساخت API Key در دیدار #

برای اتصال یک وب‌سایت، نرم‌افزار یا سرویس دیگر به دیدار و استفاده از APIهای دیدار، ابتدا به یک API Key نیاز دارید.

API Key در واقع کلیدی است که سیستم شما هنگام ارسال Request به APIهای دیدار از آن برای احراز هویت استفاده می‌کند.

چه کسانی می‌توانند API Key دریافت کنند؟ #

ساخت و مدیریت API Key فقط در اختیار کاربرانی است که دسترسی ادمین در دیدار دارند.

اگر با کاربری غیر از ادمین وارد دیدار شده‌اید، امکان ساخت و مدیریت API Key را نخواهید داشت و باید از مدیر حساب دیدار خود بخواهید این کار را انجام دهد.

ساخت API Key در دیدار #

برای ایجاد یک API Key جدید:

1. وارد حساب کاربری خود در دیدار شوید.

2. وارد بخش «تنظیمات» شوید.

3. از منوی تنظیمات، گزینه «اتصال به سرورهای دیگر» را انتخاب کنید.

4. وارد تب «اتصال به دیدار» شوید.

5. در این بخش یک کلید دسترسی جدید ایجاد کنید.

6. نام و نوع دسترسی موردنظر برای کلید را مشخص کنید.

7. قبل از ذخیره و ایجاد کلید API جدید باید مقدار API Key را کپی کرده و در جای امنی ذخیره کنید. دقت داشته باشید که مقدار API Key پس از ایجاد دیگر به شما نمای داده نخواهد شد و درصورتی که کلید           خود را فراموش کردید باید کلید API جدیدی ایجاد کنید.

API Key را همان لحظه ذخیره کنید #

مقدار API Key فقط هنگام ایجاد اولیه کلید به شما نمایش داده می‌شود و بعداً امکان مشاهده مجدد آن در دیدار وجود ندارد.

بنابراین بعد از ساخت کلید، حتماً همان لحظه مقدار API Key را در محل امنی ذخیره کنید.

اگر API Key را فراموش یا گم کردید، باید از همین بخش یک API Key جدید ایجاد کنید.

API Key را با API ID اشتباه نگیرید #

بعد از ساخت کلید ممکن است در بخش مدیریت APIها اطلاعات دیگری مثل API ID نیز مشاهده کنید.

برای ارسال Request و احراز هویت در APIهای دیدار باید از مقدار API Key استفاده کنید، نه API ID.

API ID جایگزین API Key نیست و نمی‌توان از آن برای احراز هویت Requestها استفاده کرد.

مدیریت API Keyهای ایجادشده #

در بخش «اتصال به دیدار» می‌توانید کلیدهایی را که قبلاً ساخته‌اید مدیریت کنید.

در این بخش امکان انجام موارد زیر وجود دارد:

• مشاهده فهرست کلیدهای ایجادشده
• فعال یا غیرفعال کردن یک کلید
• ویرایش نام کلید
• ویرایش نوع دسترسی کلید
• ایجاد API Key جدید

به‌جز نام کلید و نوع دسترسی، سایر اطلاعات کلید قابل ویرایش نیستند.

API Key را در اختیار چه کسانی قرار دهیم؟ #

API Key یک اطلاعات حساس برای دسترسی به APIهای حساب دیدار شماست. هر فرد یا سیستمی که این کلید را در اختیار داشته باشد، می‌تواند براساس نوع دسترسی تعریف‌شده برای آن کلید، Requestهای API را به حساب دیدار شما ارسال کند.

بنابراین:

• API Key را فقط در اختیار افراد یا سیستم‌هایی قرار دهید که به آن‌ها اعتماد دارید.
• کلید را در کانال‌های عمومی، پیام‌های قابل دسترس برای دیگران یا کدهای عمومی منتشر نکنید.
• برای هر Integration، کلید و نوع دسترسی آن را با دقت مدیریت کنید.

مستندات کامل API دیدار #

اگر قصد دارید بعد از دریافت API Key یک Integration با دیدار پیاده‌سازی کنید، جزئیات فنی APIها در هاب مستندات فنی دیدار قرار گرفته است.

در این مستندات می‌توانید مواردی مثل این‌ها را مشاهده کنید:

• نحوه شروع کار با API
• ساختار Request و Response
• Endpointهای موجود
• فیلدهای الزامی و اختیاری
• نمونه درخواست‌ها
• نحوه استفاده از API Key

مشاهده راهنمای شروع کار با API دیدار

برای پیاده‌سازی یک سناریوی مشخص، بعد از ساخت API Key ابتدا Endpoint موردنیاز خود را در API Reference پیدا کنید و Request را مطابق همان مستندات بسازید.