Troupia API
לחבר כל מערכת לאוטומציות, להרצות ולשיחות שלכם, עם מפתח אחד.
קודם כול: מפתח API
בעלים או מנהל יוצרים אותו בהגדרות ← מפתחות API, ובוחרים מה מותר לו. כל בקשה שולחת אותו כך:
Authorization: Bearer trp_live_…
אוטומציות
/v1/automationsכל האוטומציות
של סביבת העבודה, דף אחרי דף.
automations:read/v1/automations/{automationId}אוטומציה אחת
השלבים, כל הדרכים שבהן היא מתחילה, והגרסה. אף פעם לא סוד.
automations:readETag: "7.1a2b3c4d"
שמרו את ה-ETag. שינוי שולח אותו בחזרה.
/v1/automations/{automationId}שינוי שם
automations:writeIf-Match: "7.1a2b3c4d"
אם מישהו שינה את האוטומציה מאז שקראתם: 412, ושום דבר לא נדרס. קוראים שוב ומחליטים.
/v1/automations/{automationId}/enableהפעלה
רצפת התזמון של התוכנית חלה, כמו באפליקציה.
automations:writeIf-Match: "7.1a2b3c4d"
בקשה למצב שכבר קיים מחזירה 200 ולא משנה כלום. ריצות מתוזמנות לא נפגעות.
/v1/automations/{automationId}/disableהשהיה
automations:writeIf-Match: "7.1a2b3c4d"
בקשה למצב שכבר קיים מחזירה 200 ולא משנה כלום. ריצות מתוזמנות לא נפגעות.
/v1/automations/resolve-linkמקישור לאוטומציה
קישור של Troupia ← האוטומציה או ההרצה שהוא מצביע עליה.
automations:readהרצות
/v1/automations/{automationId}/runsההרצות של אוטומציה
דף אחרי דף.
runs:read/v1/automations/{automationId}/analysisניתוח ההרצות
כמה הצליחו, כמה נכשלו ולמה, לאורך תקופה.
runs:read/v1/automations/runs/{runId}הרצה אחת
עם מה שנכנס ויצא בכל שלב.
runs:read_payloads/v1/runs/{runId}הרצה של שיחה
data:readשיחות
/v1/conversationsהשיחות
data:read/v1/conversationsפתיחת שיחה
chat:write/v1/conversations/{conversationId}/messagesשליחת הודעה
chat:write/v1/conversations/{conversationId}/exportייצוא שיחה
data:readWebhooks
/v1/automations/{automationId}/webhookכתובות ה-webhook והסודות שלהן
webhooks:manageרק מפתח של בעלים או מנהל: נבדק בכל קריאה, וכל קריאה נרשמת ביומן.
/v1/webhook-endpoints/{endpointId}/deliveriesמסירות שנכשלו
לכתובת יוצאת אחת: מהחדשה לישנה, דף אחרי דף.
webhooks:manageתוספים
/v1/plugins/{slug}/openapi.jsonה-API של תוסף
לכל תוסף מסמך OpenAPI משלו.
data:read/v1/plugins/{slug}/{entity}רשומות של תוסף
data:read/v1/plugins/{slug}/{entity}יצירת רשומה
data:write/v1/plugins/{slug}/{entity}/{id}רשומה אחת
data:read/v1/plugins/{slug}/{entity}/{id}עדכון רשומה
data:write/v1/plugins/crm/{path}קריאה מה-CRM
crm:read/v1/plugins/crm/{path}כתיבה ל-CRM
crm:writeעל ה-API
/v1/openapi.jsonהמסמך הזה
כ-OpenAPI 3.1, בלי מפתח.
בלי מפתחכשמשהו לא עובר
| 401 | אין מפתח, או שהוא לא תקף. |
| 403 | למפתח אין את ההרשאה הזו. |
| 404 | לא נמצא בסביבת העבודה הזו. |
| 412 | האוטומציה השתנתה מאז שקראתם. |
| 428 | חסר If-Match. |
| 429 | יותר מדי בקשות. חכו ונסו שוב. |