کلید API و وبهوک

کلید API به چه دردی می‌خورد؟

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

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

ساخت کلید

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

1. 1در پنل به «تنظیمات ← توسعه‌دهندگان» بروید.
2. 2روی «کلید تازه» بزنید و برایش نامی بگذارید که بعداً بفهمید کجا استفاده شده.
3. 3دسترسی را انتخاب کنید: فقط‌خواندنی برای گزارش‌گیری، و نوشتنی فقط اگر واقعاً لازم است.
4. 4کلید را همان‌جا کپی و در جای امنی ذخیره کنید.

اگر کلید لو رفت

کلید را باطل کنید؛ از همان لحظه دیگر کار نمی‌کند و لازم نیست منتظر چیزی بمانید. بعد یک کلید تازه بسازید و جایگزینش کنید. باطل‌کردن کلید هیچ داده‌ای را پاک نمی‌کند.

وبهوک برای چیست؟

به‌جای اینکه هر چند دقیقه از ما بپرسید «پاسخ تازه‌ای آمده؟»، ما به‌محض رسیدن پاسخ به آدرسی که بدهید خبر می‌دهیم. برای فرستادن اعلان به اسلک یا تلگرام تیم، یا راه‌انداختن یک فرآیند داخلی، همین کافی است.

هر درخواست امضا دارد تا مطمئن شوید واقعاً از طرف ماست. راز امضا هم مثل کلید، فقط یک‌بار نشان داده می‌شود.

1. 1در همان صفحه به زبانه «وبهوک‌ها» بروید.
2. 2آدرس مقصد را بدهید — باید https باشد و روی اینترنت در دسترس.
3. 3رویدادهایی را که می‌خواهید انتخاب کنید.
4. 4با دکمه «تست» یک درخواست نمونه بفرستید و ببینید سمت شما درست دریافت می‌شود.

اگر مقصد جواب ندهد

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