تخطّ إلى المحتوى الرئيسي

Integrations API

تعرض صفحة التكاملات في لوحة التحكم حالة على كل بطاقة (WhatsApp و Delivyr ومنصات الإعلانات والمتاجر ومستودعات البيانات وأدوات التحليلات). تعيد نقطة النهاية هذه الحالة نفسها، حتى يتمكن سكربت أو مهمة مراقبة من التحقق من أن مساحة العمل ما زالت متصلة دون فتح لوحة التحكم.

يبقى الربط وقطع الاتصال في لوحة التحكم. هذه الواجهة للقراءة فقط.

كل نقاط النهاية في هذه الصفحة نسبية إلى عنوان الأساس: https://api-eu1.joryio.com/api - راجع نظرة عامة على API.

المصادقة​

استخدم مفتاح API كرمز bearer (أو جلسة لوحة التحكم). يحتاج المفتاح إلى الصلاحية integrations:read. ينتمي المفتاح إلى مساحة عمل واحدة، والإجابة تخص مساحة العمل هذه.

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 }
]
}
الحقلالنوعالمعنى
idstringالتكامل: whatsapp و delivyr و meta_ads و google_ads و tiktok_ads و linkedin_ads و criteo_ads و shopify و woocommerce و magento و prestashop و snowflake و bigquery و s3 و redshift و amplitude و mixpanel و segment. تُضاف تكاملات جديدة مع الوقت - تجاهل أي id لا تعرفه.
statusstringما تعرضه البطاقة - راجع قيم الحالة.
connectedbooleantrue عندما يكون اتصال واحد على الأقل خلف التكامل نشطًا. المتجر الذي فشلت آخر مزامنة له يبقى متصلًا (status هي error و connected هي true).
countnumberعدد الحسابات المتصلة أو تدفقات البيانات أو المتاجر خلف التكامل. غير موجود لـ WhatsApp ولا لتكامل غير متاح بعد.

قيم الحالة​

statusالمعنى
connectedمتصل ويعمل.
not_connectedلم يُربط شيء بعد.
action_neededلـ WhatsApp فقط: أُضيف حساب وهو بانتظار الموافقة.
errorمتصل، لكن هناك ما يحتاج إلى انتباه: حساب في منصة إعلانات يبلّغ عن خطأ، أو فشلت آخر مزامنة لمتجر. افتح التكامل في لوحة التحكم لمعرفة ما الذي فشل.
coming_soonالتكامل غير متاح بعد.

عندما يتكون التكامل من أكثر من جزء (مثل Snowflake: استيراد البيانات وتدفق الأحداث)، تتقدم error في أي جزء، ثم connected، ثم action_needed.

ما الذي يُعد متصلًا​

  • WhatsApp: حساب WhatsApp Business نشط لمساحة العمل أو للمؤسسة كلها، أو مزوّد WhatsApp نشط أعدّته Joryio.
  • المتاجر (Shopify و WooCommerce و Magento و PrestaShop): اتصال متجر لم يُقطع.
  • Delivyr: حساب Delivyr مربوط بمساحة العمل.
  • منصات الإعلانات والاستيراد من مستودعات البيانات: حساب متصل. يُحتسب كل حساب مرة واحدة.
  • تدفقات البيانات (S3 و BigQuery و Snowflake و Redshift و Amplitude و Mixpanel): تدفق بيانات إلى هذه الوجهة.

هذه هي القواعد نفسها التي تستخدمها Joryio في كل مكان تبلّغ فيه عن القنوات والمتاجر المتصلة.

لا تحتوي الاستجابة أبدًا على بيانات اعتماد أو أسماء حسابات أو أرقام هواتف أو عناوين مرسلين أو رسائل خطأ - فقط حالة ونعم أو لا وعدد لكل تكامل.

الأخطاء​

الحالةمتى
401مفتاح API مفقود أو غير صالح.
403المفتاح لا يملك integrations:read.
400جلسة لوحة تحكم بلا مساحة عمل محددة.
429طلبات كثيرة جدًا - راجع تحديد المعدل.

مثال​

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