المنصة · API و Webhooks

تكامل عبر HTTPS، لا عروضًا

انشر محادثة من خادم إلى خادم، وبث الرموز إلى واجهتك، وأطلق الأتمتة من webhooks تنتهي على مضيف FlexyAgents. المسارات أدناه هي معالجات Next.js الحقيقية — انسخ القيم من النشر بعد إنشاء اتصال FlexyAgents API.

  • POST /api/agents/{agentId}/chat يقبل Bearer مرتبطاً باتصال FlexyAgents automation-app ثم يشغّل نفس مكدس RAG + النموذج كعنصر الواجهة
  • البث الاختياري يعيد مقاطع JSON مفصولة بأسطر جديدة بينما الردود غير المتدفقة تُجمّع في حمولة مساعد واحدة
  • حدود المعدل لكل IP تُطبَّق قبل فحص الخطة؛ الخطط المستضافة ما زالت تفرض ميزانيات الرموز وخطط BYOK تعيد أخطاء صريحة عند غياب مفتاح المزود
  • Webhook triggers وcallbacks القنوات والتكاملات الصادرة تشترك في نموذج tenancy نفسه — كل شيء يُحل إلى organization وagent
اقرأ الوثائقمركز المطوّرين

تحتاج مفاتيح أولًا؟ أنشئ مساحة عمل وافتح الإعدادات → مفاتيح API أو نافذة اتصال الوكيل.

واجهات HTTP في لمحة

المسارات تعكس شجرة مسارات Next.js. استبدل العناصر النائبة بمعرّف الوكيل والمضيف من شاشة النشر.

  • POST/api/agents/{agentId}/chat

    دردشة الوكيل والبث

    أرسلوا JSON يحتوي مصفوفة messages (role + content) وعلامة stream اختيارية. Bearer يُتحقق منه مقابل مفتاح FlexyAgents API المخزّن على اتصال الوكيل؛ عند نجاح المصادقة تُحل المؤسسة تلقائياً.

  • POST/api/webhooks/automations/...

    Ingress لـ trigger الأتمتة

    الأتمتة المنشورة يمكنها عرض URLs Webhook ت deserialize الحمولات وتستدعي executeAutomation — مفيد عندما تحتاج خدماتكم لتشغيل تدفقات دون OAuth.

  • GET/POST/api/webhooks/*

    Webhooks القنوات والمزودين

    مسارات شقيقة تحت /api/webhooks تتعامل مع WhatsApp وInstagram وFacebook Messenger والبريد الوارد وcallbacks مماثلة ليبقى نشر omni-channel على نطاقكم.

  • —Integrations → Webhooks

    التسليم الصادر

    اضبطوا webhooks صادرة موقّعة من لوحة التحكم عندما تريد FlexyAgents أن يدفع أحداث المحادثة أو النظام إلى SIEM أو data lake أو ticketing bridge.

استدعاء بسيط بدون بث

# YOUR_APP_HOST: استبدلوا باسم مضيف التطبيق في الإنتاج
# YOUR_FLEXYAGENTS_API_KEY: مفتاح FlexyAgents API المرتبط باتصال الوكيل
curl -X POST "https://YOUR_APP_HOST/api/agents/AGENT_ID/chat" \
  -H "Authorization: Bearer YOUR_FLEXYAGENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"مرحباً"}],"stream":false}'

استبدل بالقيم المنسوخة من النشر → API بعد ربط تطبيق FlexyAgents على ذلك الوكيل.

الاستدعاء

دردشة HTTPS أولاً بنفس «العقل» كعنصر الواجهة

شاشة النشر تنسخ snippet curl ضد المضيف الحي. داخلياً يتحقق المعالج من مفاتيح API عبر مخزن اتصالات الأتمتة، يحمّل السلوك والمعرفة، ويزيد الاستخدام كأي قناة أخرى.

  • عقد مصفوفة messages

    يجب أن تحتوي الأجسام على دورة دردشة واحدة على الأقل. المنفّذ يقلّص السجل إلى آخر رسالة مستخدم للاسترجاع مع قبول مصفوفات multi-turn للاستخدام المستقبلي.

    • الأدوار محدودة بـ user أو assistant أو system في المُحقّق
    • أرفقوا metadata في headers فقط حيث موثّق — التزموا بعقد JSON أولاً
    • الأشكال غير الصالحة تعيد 400 مع تفاصيل Zod لتسريع التصحيح
    افتحوا تبويب Deployment

  • وضع البث

    اضبطوا stream: true لاستلام مقاطع NDJSON (كائن JSON لكل سطر) يمكن للواجهات الأمامية عرضها كرموز تصل.

    • مثالي لعملاء جوال أو سطح مكتب يريدون parity مع عنصر الواجهة المستضاف
    • أخطاء mid-stream ما زالت ت serialize كأسطر JSON ليتعافى المحلّل
    • عطّلوا البث عندما تعمل proxies على buffer الردود بقوة
    سياق فوترة النماذج

  • مفاتيح Bearer API مقابل session cookies

    حسابات الخدمة يجب أن تستخدم مفتاح اتصال FlexyAgents المُولَّد لكل وكيل. المختبرون التفاعليون يمكنهم الاعتماد على جلسات لوحة التحكم، لكن server-to-server يجب أن يستخدم Bearer دائماً.

    • المفاتيح تُشفَّر at rest إلى جانب بيانات اعتماد الأتمتة الأخرى
    • تدوير مفتاح لا يغيّر agent ID في URL
    • مفاتيح غير صالحة أو مفقودة تعيد 401 قبل أي إنفاق نموذج

  • حدود سترونها في الإنتاج

    حدود المعدل المدعومة بـ Redis تعيد 429 عند ذروة الحركة. فرض الخطة يضيف MESSAGE_LIMIT_REACHED لسقوف BYOK/المستضاف الشهرية وسقوف الرموز للاستدلال المستضاف.

    • الأتمتة والدردشة تشتركان في نفس قصة المحاسبة على مستوى المؤسسة
    • سجّلوا correlation IDs من حمولات الخطأ عند التحدث مع الدعم
    • رقّوا أو أضيفوا credits حيث يسمح الفوتر بالإ throughput الإضافي
    الاستخدام والخطط

الأحداث

Bring your stack إلى FlexyAgents — وادفعوا الأحداث للخارج

المسارات الواردة تطبّع تواقيع المزود بينما الإعداد الصادر يعيش بجانب التكاملات الأخرى. الأتمتة يمكنها أيضاً POST HTTP تعسفي ضمن تدفق.

  • Webhook triggers للأتمتة

    عندما ينشر تدفق webhook trigger، يخزّن FlexyAgents segment المسار ويتحقق من الحمولات قبل استدعاء executeAutomation بالجسم الم parsed.

    • اجمعوا مع خطوات وكيل تستدعي Slack أو CRMs أو REST مخصص
    • تقييد الميزة قد يتطلب خططاً م upgraded قبل تفعيل ingress عام
    • السجلات تظهر في نفس سجل تشغيل الأتمتة كـ OAuth triggers
    نظرة عامة على الأتمتة

  • Callbacks مزودي القنوات

    WhatsApp وInstagram DMs وMessenger والبريد الوارد يسجلون endpoints HTTPS عامة ليتمكن Meta أو Twilio أو مزودو البريد من التحقق وتسليم الأحداث.

    • اضبطوا callback URLs في الواجهة المزود لتطابق مضيف النشر
    • مصافحات التحقق تحدث على نفس المسارات كالحركة الحية
    • يبقي الحمولات الحساسة للامتثال على بنية تحتية تراجعونها أصلاً
    نشر القنوات

  • HTTP actions صادرة

    إجراءات الأتمتة يمكنها POST أو PUT إلى URLs مملوكة للعميل بأجسام قالب — مثل «notify Opsgenie» أو «create Jira ticket» دون انتظار موصل first-party.

    • عيّنوا حقول trigger في أجسام JSON عبر automation builder
    • إعادة المحاولة ومعالجة الأخطاء تتبع defaults منفّذ الأتمتة
    • اجمعوا مع خطوات وكيل لملخصات readable قبل التسليم

المرجع

Specs وDocs وأدوات استكشاف

صفحات التسويق تبقى سردية؛ المهندسون يجب أن يعتمدوا على موقع Docs وOpenAPI في المستودع وsnippets صفحة النشر التي تطابق tenant IDs دائماً.

  • مركز التوثيق

    ابدأوا من /docs للأدلة المفاهيمية، ثم اربطوا بصفحة /api للمطورين للبدء السريع ومقدمات Auth ومراجع tabbed عند التوفر.

    • أمثلة تركز على curl وJavaScript وأنماط تضمين عنصر الواجهة
    • وعود SDK/Postman يجب أن تطابق ما نوفره فعلاً
    • أبلغوا عن الفجوات عبر الدعم لمواءمة التسويق والكتابة التقنية
    افتحوا Docs

  • OpenAPI كمصدر حقيقة

    المستودع يحمل OpenAPI شاملاً يصف مخططات Auth وحمولات الدردشة وموارد REST مساعدة — ولّدوا clients أو استوردوا إلى Postman من ذلك الملف.

    • الإصدارات تتبع cadence إصدار الحزمة وليس صفحة الهبوط هذه
    • Base URLs للstaging والإنتاج مُدرجة في قائمة servers في Spec
    • المطورون المحليون يضربون نفس /api/agents/{id}/chat على localhost كالإنتاج على tenant host
    صفحة Developer API

  • عنصر الواجهة ومرافقو الجوال

    ليست كل تجربة تحتاج REST خام — السكript القابل للتضمين يستدعي نفس endpoint الدردشة بسياق الزائر. اجمعوا API مع عنصر الواجهة لخدمة ذاتية على الويب ووظائف backend.

    • الصفحات المستضافة تعيد استخدام إعداد الوكيل الذي اختبرتموه
    • CSP وسياسات Cookie يجب أن تسمح بأصل عنصر الواجهة الذي تضبطونه
    • Deep links من البريد يمكنها فتح hosted chat بمعاملات query
    أسطح الويب

ازِج واجهات API مع الأتمتة والقنوات والحوكمة في التحليلات.

الخطوة التالية

انسخ curl يعمل، ثم شدّد للإنتاج

أنشئ مفتاح اتصال FlexyAgents، والصقه في مخزن الأسرار، ووجّه webhooks الأتمتة إلى المسارات التي تملكها. عندما تكون جاهزًا، اربط المراقبة بنفس مساحة التحليلات التي يستخدمها فريق النجاح.

جرّبه مجانًااحجز عرضًا