API توسعه‌دهنده

تب توسعه‌دهندگان جایی است که کلیدهای API را برای دسترسی برنامه‌نویسی به Entergram صادر می‌کنید. در پلن Pro (و صندلی‌های Pro فضای کاری) در دسترس است. فقط مالکان و مدیران.

ایجاد یک کلید

1. «Create API key»
2. آن را نام‌گذاری کنید (چیزی که بعداً در یک لیست لغو آن را بشناسید)
3. دامنه‌ها را انتخاب کنید - مجوزهای ریزدانه مانند:
   • workspace.read
   • members.read
   • accounts.read
   • contacts.read
   • chats.read / chats.write
   • custom_fields.read / custom_fields.write
4. TTL پیش‌فرض ۹۰ روز است؛ می‌توانید مدت کوتاه‌تری انتخاب کنید
5. اختیاری: محدود کردن به فهرستی از بازه‌های IP CIDR
6. روی Create کلیک کنید - کلید کامل یک‌بار نمایش داده می‌شود. فوراً آن را کپی کنید؛ Entergram هرگز دوباره آن را نشان نمی‌دهد.

پشت پرده

• کلیدها به‌صورت هش‌های یک‌طرفه ذخیره می‌شوند - کلید خام هرگز روی دیسک قرار نمی‌گیرد
• هر درخواست پیشوند، IP و عامل کاربر را برای حسابرسی ثبت می‌کند
• لغو فوری است
• کلیدهای منقضی‌شده به‌طور خودکار 403 برمی‌گردانند
• هر فراخوانی API محدود به فضای کاری است - یک کلید فقط می‌تواند روی فضای کاری که آن را صادر کرده عمل کند

مدیریت کلیدها

از تب توسعه‌دهندگان:

• پیشوند، تاریخ ایجاد، دامنه‌ها، TTL و اطلاعات آخرین استفاده هر کلید را ببینید
• پیشوند را کپی کنید (نه مقدار مخفی)
• یک کلید را لغو یا بچرخانید
• چرخش = یک کلید جدید با همان دامنه‌ها ایجاد کنید، سپس وقتی یکپارچه‌سازی شما منتقل شد کلید قدیمی را لغو کنید

مثال: چرخش یک کلید درزکرده

1. متوجه می‌شوید که یک مهندس یک کلید را در یک ردیاب مسئله عمومی چسبانده است
2. تب توسعه‌دهندگان ← کلید را پیدا کنید ← Revoke (بلافاصله اعمال می‌شود)
3. یک کلید جدید با همان دامنه‌ها و فهرست مجاز IP ایجاد کنید
4. کلید جدید را به یکپارچه‌سازی خود مستقر کنید
5. اطلاعات آخرین استفاده کلید قدیمی را بررسی کنید تا تأیید شود ترافیک بیشتری وجود ندارد

مثال: ساخت یک کلید برای یک کار CI

1. تب توسعه‌دهندگان ← Create API key
2. آن را ci-deploy-bot نام‌گذاری کنید
3. دامنه‌ها: فقط workspace.read و chats.read (حداقل امتیاز)
4. TTL: ۳۰ روز
5. فهرست مجاز IP: IPهای خروجی ارائه‌دهنده CI
6. کلید را کپی کنید و آن را به‌عنوان یک راز در CI تنظیم کنید
7. پیش از انقضای TTL بچرخانید

یکپارچه‌سازی Make.com

پلن‌های Pro شامل یک یکپارچه‌سازی Make.com هستند، بنابراین می‌توانید Entergram را بدون نوشتن کد API به اتوماسیون‌های کم‌کد متصل کنید. از ناحیه یکپارچه‌سازی‌های فضای کاری در دسترس است.

پاسخ‌های API

خطاهای رایج HTTP که خواهید دید:

• 401 - کلید منقضی، لغوشده یا برای فضای کاری اشتباه است
• 403 - کلید دامنه لازم را ندارد، یا درخواست از یک IP خارج از فهرست مجاز است
• 429 - به یک محدودیت نرخ رسیده‌اید؛ عقب‌نشینی کنید و دوباره تلاش کنید