לדלג לתוכן הראשי

API למפתחים ו-webhooks

צרו מפתחות API, רשמו נקודות קצה של webhook וסקרו יומני בקשות ממרכז המפתחים.

נכתב על ידי Sarah Chen

מרכז המפתחים הוא המקום שבו אתם מחברים את Exayard לקוד ולכלים שלכם. פתחו אותו מהגדרות ואז מפתחים. מכאן אתם יוצרים מפתחות API, רושמים נקודות קצה של webhook, וסוקרים יומן חי של כל בקשת API. רק מנהלי ארגון יכולים להגיע לעמוד זה.

מפתחות API

מפתח API מאמת בקשות ל‑API של Exayard. מפתחות שייכים לארגון שלכם, ולכן החשבון הנכון נבחר אוטומטית ואין מזהה ארגון להעביר.

פתחו את הכרטיסייה מפתחות API בכרטיס אישורים ולחצו על כפתור ה‑+. תנו למפתח שם, ואז בחרו את ההיקפים שלו. בחרו הכול כדי להעניק כל היקף, או ספציפי כדי לבחור הרשאות בודדות. ההיקפים עוקבים אחר חלוקה לקריאה וכתיבה לכל משאב, כמו read:projects ו‑write:estimates. ההיקף admin:org הוא הענקת גישה מלאה. בחרו את ההיקפים המינימליים שהאינטגרציה שלכם צריכה.

Exayard מציג את המפתח המלא פעם אחת, מיד לאחר שאתם יוצרים אותו. העתיקו אותו אז, מכיוון שהוא לעולם לא מוצג שוב. לאחר מכן, כל מפתח מופיע עם שמו, תצוגה מקדימה ממוסכת כמו ak_••••1234, והתאריך שבו נעשה בו שימוש לאחרונה.

השתמשו בסמל העיפרון כדי לשנות שם של מפתח או לשנות את ההיקפים שלו. השתמשו בסמל פח האשפה כדי לבטל אותו. הביטול הוא לצמיתות וכל אינטגרציה המשתמשת באותו מפתח מפסיקה לעבוד מיד.

אותו מפתח מאמת את האינטגרציות ללא הקוד. ראו חיבור Exayard ל‑Zapier, חיבור Exayard ל‑Make, וחיבור Exayard ל‑n8n. לגישה לסוכנים ועורכי AI, ראו חיבור ל‑Claude וכלי AI אחרים.

Webhooks

webhook אומר ל‑Exayard להודיע לשרת שלכם כשמשהו קורה. פתחו את הכרטיסייה Webhooks ולחצו על + כדי להוסיף נקודת קצה. הזינו את הURL שאמור לקבל מסירות ותיאור אופציונלי.

בחרו לאילו אירועים להירשם. בחרו הכול כדי לקבל כל אירוע, או ספציפי כדי לבחור מהרשימה:

אירוע

מופעל כאשר

project.created

פרויקט נוצר

project.updated

פרויקט משתנה

project.archived

פרויקט מועבר לארכיון

assessment.started

הערכת מדידת כמויות מתחילה

assessment.completed

הערכה מסתיימת

assessment.approved

הערכה מאושרת

assessment.cancelled

הערכה מבוטלת

estimate.generated

אומדן נוצר

bid.generated

הצעת מחיר נוצרה

file.processed

קובץ שהועלה מסיים עיבוד

כשאתם יוצרים נקודת קצה, Exayard מציג סוד חתימה פעם אחת. העתיקו אותו אז, מכיוון שהוא אינו מוצג שוב.

אבטחת מסירות webhook

כל מסירה נושאת כותרת Exayard-Signature בצורה t=<unix>,v1=<digest>. Exayard בונה את החתימה על ידי צירוף חותמת הזמן וגוף הבקשה, ואז חותם אותם עם HMAC-SHA256 באמצעות סוד נקודת הקצה שלכם.

כדי לאמת מסירה, חשבו מחדש את החתימה עם הסוד שלכם, ודאו שחותמת הזמן היא בטווח של חמש דקות מהרגע הנוכחי, והשוו את ה‑digests. מסירות שנכשלו חוזרות על עצמן עם נסיגה מעריכית לאורך כשלושה ימים.

כדי לערוך נקודת קצה, לחצו על סמל העיפרון. תוכלו לשנות את ה‑URL, התיאור והאירועים, ולהגדיר את הסטטוס שלה לפעיל או מושהה. נקודות קצה מושהות מפסיקות לקבל מסירות. לאותו דיאלוג יש כפתור סובב סוד. הסיבוב מנפיק סוד חדש והישן מפסיק לעבוד מיד, ולכן עדכנו את השרת שלכם לפני שאתם מסובבים. סמל פח האשפה מוחק נקודת קצה ומסיים את כל המסירות אליה.

התחלה מהירה

כרטיס התחלה מהירה מחזיק הנחיה מוכנה מראש עבור עורך AI כמו Claude או Cursor. לחצו על העתק הנחיה והדביקו אותה בעורך שלכם. ההנחיה כוללת את כתובת הבסיס של ה‑API, פורמט האימות, אוצר המילים של ההיקפים, וסכמת חתימת ה‑webhook, כך שה‑AI יכול לבנות אינטגרציה עובדת ולבקש מכם את הפרטים שהוא צריך.

תיעוד

כרטיס תיעוד מקשר לתיעוד המפתחים המלא ולמפרט OpenAPI, המתאר כל נתיב וסכמה. חבר MCP פותח את ההגדרה לחיבור סוכני AI ישירות ל‑Exayard.

יומנים

מקטע יומנים מתעד את בקשות ה‑API האחרונות שלכם הן ב‑REST API והן ב‑MCP. כל שורה מציגה את השיטה, הנתיב, סטטוס התגובה וההשהיה. בחרו שורה כדי לראות את הפרטים המלאים שלה, כולל מזהה הבקשה וגופי הבקשה והתגובה. השתמשו ביומנים כדי לאשר שקריאה עבדה או כדי לבצע ניפוי שגיאות של אינטגרציה כושלת.

האם קיבלת תשובה לשאלתך?