Integrations API

עמוד האינטגרציות בלוח הבקרה מציג סטטוס על כל כרטיס (WhatsApp, ‏Delivyr, פלטפורמות הפרסום, החנויות, מחסני הנתונים וכלי האנליטיקה). נקודת הקצה הזו מחזירה את אותו הסטטוס, כך שסקריפט או משימת ניטור יכולים לבדוק שה-workspace עדיין מחובר בלי לפתוח את לוח הבקרה.

החיבור והניתוק נשארים בלוח הבקרה. ה-API הזה לקריאה בלבד.

כל נקודות הקצה בעמוד זה יחסיות לכתובת הבסיס: https://api-eu1.joryio.com/api - ראו סקירת API.

אימות

השתמשו במפתח API כאסימון bearer (או בהתחברות ללוח הבקרה). המפתח צריך את ההרשאה integrations:read. מפתח שייך ל-workspace אחד, והתשובה מתייחסת ל-workspace הזה.

Authorization: Bearer jry_live_xxxxxxxxxxxxxxxxxxxx

קבלת הסטטוס של כל האינטגרציות

GET /integrations-hub/status

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

{
  "integrations": [
    { "id": "whatsapp", "status": "connected", "connected": true },
    { "id": "delivyr", "status": "not_connected", "connected": false, "count": 0 },
    { "id": "meta_ads", "status": "error", "connected": true, "count": 2 },
    { "id": "shopify", "status": "connected", "connected": true, "count": 1 },
    { "id": "snowflake", "status": "connected", "connected": true, "count": 1 },
    { "id": "segment", "status": "coming_soon", "connected": false }
  ]
}

שדה	סוג	משמעות
`id`	string	האינטגרציה: `whatsapp`, `delivyr`, `meta_ads`, `google_ads`, `tiktok_ads`, `linkedin_ads`, `criteo_ads`, `shopify`, `woocommerce`, `magento`, `prestashop`, `snowflake`, `bigquery`, `s3`, `redshift`, `amplitude`, `mixpanel`, `segment`. אינטגרציות חדשות מתווספות עם הזמן - התעלמו מ-id שאינכם מכירים.
`status`	string	מה שהכרטיס מציג - ראו ערכי סטטוס.
`connected`	boolean	`true` כשלפחות חיבור אחד מאחורי האינטגרציה פעיל. חנות שהסנכרון האחרון שלה נכשל עדיין מחוברת (`status` הוא `error`, ו-`connected` הוא `true`).
`count`	number	כמה חשבונות מחוברים, זרמי נתונים או חנויות יש מאחורי האינטגרציה. לא מופיע עבור WhatsApp ועבור אינטגרציה שעדיין אינה זמינה.

ערכי סטטוס

`status`	משמעות
`connected`	מחובר ועובד.
`not_connected`	עדיין לא חובר דבר.
`action_needed`	ב-WhatsApp בלבד: נוסף חשבון והוא ממתין לאישור.
`error`	מחובר, אבל משהו דורש טיפול: חשבון בפלטפורמת פרסום מדווח על שגיאה, או שהסנכרון האחרון של חנות נכשל. פתחו את האינטגרציה בלוח הבקרה כדי לראות מה נכשל.
`coming_soon`	האינטגרציה עדיין אינה זמינה.

כשלאינטגרציה יש יותר מחלק אחד (למשל Snowflake: ייבוא נתונים והזרמת אירועים), error בחלק כלשהו גובר, אחריו connected, ואחריו action_needed.

מה נחשב מחובר

WhatsApp: חשבון WhatsApp Business פעיל של ה-workspace או של הארגון כולו, או ספק WhatsApp פעיל שהוגדר על ידי Joryio.
חנויות (Shopify, ‏WooCommerce, ‏Magento, ‏PrestaShop): חיבור חנות שלא נותק.
Delivyr: חשבון Delivyr שמחובר ל-workspace.
פלטפורמות פרסום וייבוא ממחסני נתונים: חשבון מחובר. כל חשבון נספר פעם אחת.
זרמי נתונים (S3, ‏BigQuery, ‏Snowflake, ‏Redshift, ‏Amplitude, ‏Mixpanel): זרם נתונים ליעד הזה.

אלה אותם הכללים ש-Joryio משתמשת בהם בכל מקום שבו היא מדווחת על ערוצים וחנויות מחוברים.

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

שגיאות

סטטוס	מתי
`401`	מפתח ה-API חסר או אינו תקף.
`403`	למפתח אין את ההרשאה `integrations:read`.
`400`	התחברות ללוח הבקרה בלי workspace נבחר.
`429`	יותר מדי בקשות - ראו מגבלות קצב.

דוגמה

curl https://api-eu1.joryio.com/api/integrations-hub/status \
  -H "Authorization: Bearer jry_live_xxxxxxxxxxxxxxxxxxxx"

אימות​

קבלת הסטטוס של כל האינטגרציות​

ערכי סטטוס​

מה נחשב מחובר​

שגיאות​

דוגמה​