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

אפליקציות, מפתחות API, Webhooks ויומנים כלולים בכל תוכנית, כולל Free. רק עבודת AI מחויבת.

אפליקציה היא אחת האינטגרציות שלכם, כמו "Acme estimator" או "Nightly sync". כל מפתח API שייך לאפליקציה. אפליקציות הוא האזור הראשון בדף. כל חברי הצוות יכולים לקרוא אותו. רק מנהלים יוצרים או משנים אפליקציות.

לחצו על אפליקציה חדשה ומלאו את שם, תיאור, דף הבית, כתובת דוא"ל לתמיכה והרשאות. ההרשאות מחולקות לקריאה ולכתיבה לכל משאב, לדוגמה read:projects ו-write:estimates. אפליקציות לא יכולות לבקש את ההרשאה admin:org. לחברה יכולות להיות עד 25 אפליקציות.

כל אפליקציה מציגה מתי היא נוצרה ואת מגבלת הקצב שלה, לדוגמה "עד 60 בקשות בדקה לכל חברה ו-600 בסך הכול". התפריט פעולות נוספות של האפליקציה מכיל:

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

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

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

מפתח מתחיל ב-exa_live_. מפתח שנוצר בסביבת Sandbox מתחיל ב-exa_test_. לאחר היצירה, המפתח מציג את שמו, תצוגה מקדימה כמו exa_live_...AbCd, ואת שימוש אחרון או לא נעשה שימוש. מפתח עם תאריך תפוגה מציג תוקף עד ואת התאריך, ומפתח שפג תוקפו מציג פג תוקף.

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

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

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

כאשר חברה אחרת התקינה את האפליקציה שלכם, תיבת הדו-שיח של מפתח חדש מציגה גם פועל ב. החברה הזו היא ברירת המחדל. כל חברה שהתקינה אותה יוצר מפתח שהשרת שלכם משתמש בו בכל אחת מהחברות האלה. כל קריאה מציינת אז את החברה שלה בכותרת Exayard-Organization-Id.

אותם מפתחות מחברים גם את הכלים ללא קוד. ראו חיבור Exayard ל-Zapier, חיבור Exayard ל-Make ו-חיבור Exayard ל-n8n. לעוזרי AI, ראו חיבור Exa לעוזר הבינה המלאכותית שלכם.

מפתחות שנוצרו לפני שהמפתחות עברו לתוך אפליקציות מתחילים ב-ak_. הם ממשיכים לפעול, אבל אי אפשר ליצור חדשים. הם מופיעים תחת מפתחות ישנים בתחתית הדף, רק כל עוד יש כאלה.

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

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

לחצו על סביבת Sandbox חדשה, תנו לה שם ולחצו על יצירה. לחברה יכולות להיות עד 5 סביבות Sandbox. פתיחה מעבירה אתכם לסביבת ה-Sandbox, ובורר החברות מסמן אותה Sandbox. צרו בה אפליקציה ומפתח כרגיל. המפתחות שלה מתחילים ב-exa_test_. כדי לעבור לסביבה האמיתית, צרו את אותה אפליקציה ואותו מפתח בחברה האמיתית שלכם והחליפו את המפתח בקוד שלכם.

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

סביבת Sandbox לא שולחת הודעות דוא"ל לשיתוף הצעות מחיר או עותקים חתומים לאנשים מחוצה לה, והיא לא שולחת הודעות SMS. הן מוצגות כ"לא נשלח כי החברה הזו היא סביבת Sandbox". הזמנות להצטרף לסביבת ה-Sandbox נשלחות כרגיל.

חישובי כמויות וקריאות קבצים בסביבת Sandbox מחזירים תוצאות שהועתקו מהפרויקט לדוגמה שלנו, ללא עלות. חישוב הכמויות, העמודים שלו וה-Webhook שנשלח עם סיום חישוב הכמויות מסומנים כדוגמאות. גם אומדנים, הצעות מחיר, חיפוש רכיבים וצ'אט עונים עם דוגמאות, ללא עלות.

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

Webhook מורה ל-Exayard לשלוח הודעה לשרת שלכם כאשר משהו קורה בחברה שלכם. כל חברי הצוות יכולים לקרוא את הרשימה. רק מנהלים מוסיפים או משנים Webhooks.

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

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

פתחו את התפריט פעולות נוספות של ה-Webhook עבור כל השאר:

אירוע בדיקה ושליחה חוזרת נשלחים פעם אחת ולעולם לא מנוסים שוב.

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

כל שליחה כוללת גם את הכותרות Exayard-Event-Id, Exayard-Event-Type ו-Exayard-Organization-Id. גוף ה-JSON כולל שדה organizationId שמציין את החברה שממנה הגיע האירוע. הכותרת נושאת את אותו מזהה, כך שאפשר לנתב שליחה עוד לפני קריאת הגוף. החתימה מכסה את הגוף כולו, כולל organizationId.

מאחר שכל שליחה מציינת את החברה שלה, כתובת קבלה אחת יכולה לשרת חברות רבות. רשמו את אותה כתובת URL בכל חברה ונתבו כל שליחה לפי organizationId. לכל Webhook יש סוד משלו, לכן בחרו את הסוד לפי Exayard-Organization-Id לפני האימות.

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

שליחה שנכשלה מנוסה עד 10 פעמים בסך הכול, במהלך כ-80 שעות, עם המתנות ארוכות יותר בין הניסיונות. כל ניסיון שולח את אותו גוף ואת אותו מזהה אירוע. הפניה מחדש (redirect) נחשבת לכישלון.

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

מנהלים פותחים את התפריט פעולות התקנה עבור הפעולות הבאות:

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

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

פתחו את התפריט פעולות נוספות של האפליקציה ולחצו על Webhook. הזינו את ה-URL ולחצו על יצירה, ולאחר מכן העתיקו את הסוד חתימה, ש-Exayard מציג פעם אחת בלבד. כל חברה שהתקינה את האפליקציה שולחת את האירועים שההרשאות שהוענקו לה מכסות. האפליקציה שלכם מקבלת גם את app.installed, app.scopes_approved ו-app.uninstalled כאשר חברה מתקינה אותה, מאשרת גישה רחבה יותר או מסירה אותה. השליחות מציינות את החברה שלהן ונחתמות באותה דרך כמו Webhooks אחרים.

באותה תיבת דו-שיח אפשר לבצע השהיה והמשך של השליחות, החלפת סוד ומחיקת Webhook.

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

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

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

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

כדי לשנות את הפרויקטים בהמשך, פתחו שוב את קישור ההתקנה והתקינו עם הבחירה החדשה.

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

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

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

החיבורים האישיים שלכם מציג את כלי ה-AI והאפליקציות האחרות שחיברתם לחשבון Exayard האישי שלכם, כמו ChatGPT או Claude. הוא מופיע בראש אפליקציות מחוברות, ורק אתם רואים את החיבורים שלכם. חיבור אישי פועל בשמכם, ולכן הוא יכול לגשת לכל מה שאתם יכולים לגשת אליו.

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

האפליקציה שלכם יכולה ליצור חברות Exayard דרך ה-API עבור לקוחות שמשתמשים ב-Exayard רק דרך המוצר שלכם. החברה שלכם היא הבעלים של החברות האלה ומשלמת על עבודת ה-AI שמתבצעת בהן. אין להן חברי צוות משלהן, והאפליקציות שלכם מותקנות בהן אוטומטית.

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

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

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

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

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

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

בחרו שורה כדי לראות את הפרטים המלאים שלה, כולל מזהה בקשה, האפליקציה ומשתמש הקצה, וגוף הבקשה וגוף התגובה. השתמשו ביומנים כדי לוודא שקריאה הצליחה או כדי לברר למה אינטגרציה נכשלת.

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

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

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