کلیدهای API و API
اجازه دهید سیستم دیگری داده‌های IDup شما را تحت کلیدی که می‌توانید تجدید یا حذف کنید، بخواند و بنویسد، و راهنمای API را پیدا کنید.
کلید API یک رمز عبور است که به یک برنامه تعلق دارد نه به یک شخص. با آن به همان شیوه رفتار کنید: یکی برای هر سیستم صادر کنید و وقتی آن سیستم تغییر کرد، آن را جایگزین کنید.
ایجاد یک کلید
- باز API → مدیریت API و فشار دهید کلید جدید.
- به آن نامی بدهید که نشان دهد کدام سیستم از آن استفاده می‌کند.
- انتخاب کنید مجوزها: دسترسی کامل، یا فقط بخش‌هایی که سیستم نیاز دارد. بیشتر بخش‌ها خواندن، ایجاد و تغییر را متمایز می‌کنند.
- یک تاریخ انقضا انتخاب کنید، یا هیچ.
- استفاده کنید از نمایش و کپی روی کارت کلید برای تحویل کلید به سامانه‌ی فراخواننده. سامانه آن را در ارسال می‌کند authtoken هدر.
هر کارت کلید مجوزها، تاریخ ایجاد را نشان می‌دهد, آخرین استفاده و یک نشان مانند «فعال» یا «5 روز دیگر منقضی می‌شود».
تمدید یک کلید قبل از انقضا
چهارده روز قبل از انقضای یک کلید، یک اعلان در زنگ دریافت می‌کنید. فشار دهید تمدید روی کارت کلید و تاریخ انقضای جدید را انتخاب کنید. IDup یک کلید جدید با همان دسترسی‌ها ایجاد می‌کند. آن را بلافاصله کپی کنید، زیرا این نمایش فقط یک بار ظاهر می‌شود. کلید قدیمی تا انقضای خودش معتبر می‌ماند، پس می‌توانید سیستم را بدون وقفه تغییر دهید.
بخش‌هایی که به آن‌ها دسترسی دارید
API داده‌های مشتریان شما را پوشش می‌دهد و بسته به طرح شما، ملک‌ها و اجاره‌ها، پروفایل‌های جستجو، پرونده‌های مالیاتی، پرونده‌های امانی، حسابداری، اجرای حقوق و دستمزد و اسکن رسیدها را نیز. AI Studio و صندوق ورودی بخش‌های مخصوص خود را دارند. راهنمای API فقط بخش‌هایی را فهرست می‌کند که طرح شما شامل می‌شود.
راهنمای API
باز کنید مستندات زبانه در صفحه مدیریت API، یا API → راهنمای API. هر بخش فیلدهای خود، مثال‌های درخواست که می‌توانید کپی کنید، پاسخ‌های نمونه و کدهای خطا را نشان می‌دهد.
webhookها و سایر رابط‌ها
- آن Webhooks ارسال رویدادها به سیستم شما هنگام رخ دادن آن‌ها — ببینید ارسال رویدادها به سامانه‌ی خودتان با webhook.
- اگر Customer API روشن باشد، یک تنظیمات API مشتریان زبانه تنظیمات آن را باز می‌کند، برای مثال اینکه مشتریان می‌توانند از طریق API ثبت‌نام کنند یا نه.
- اتوماسیون / جریان‌های کاری → رابط فنی توکنی برای رابط GraphQL صادر می‌کند.
- AI Studio → کلیدهای API شخصی مجموعه جداگانه‌ای از کلیدهاست.
نگه داشتن آن به صورت ایمن
- یک کلید به ازای هر سیستم، هرگز یک کلید مشترک.
- به یک کلید فقط مجوزهایی را بدهید که سیستم نیاز دارد.
- تاریخ انقضا را تنظیم کنید و طبق برنامه تمدید کنید.
- یک کلید را به محض اینکه کسی که آن را می‌دانست ترک کرد یا سیستم خاموش شد، حذف کنید.
هیچ چیزی ردیابی نمی‌شود — دکمه‌ها فقط یک پیام باز می‌کنند تا شما بتوانید به ما بگویید چه چیزی کم بود.
