التعريف
REST API واجهة ويب تعرض الموارد، مثل الرسائل أو جهات الاتصال أو القوالب، على عناوين URL، وتتيح للبرامج إنشاءها وقراءتها وتحديثها وحذفها باستخدام أساليب HTTP القياسية (POST وGET وPATCH وDELETE)، مع تبادل البيانات بصيغة JSON عادةً.
REST (نقل الحالة التمثيلية) نمط معماري وصفه Roy Fielding عام 2000. وعملياً، تعني واجهة REST للمراسلة إرسال طلب HTTPS موثّق، مثل POST /messages مع متن JSON، وتلقي استجابة JSON تتضمن معرّفاً وحالة. وتدل رموز حالة HTTP على النتيجة: 2xx للنجاح، و4xx لأخطاء العميل مثل الأرقام غير الصالحة أو غياب التفويض، و5xx لأخطاء الخادم.
من الأنماط المعتادة: المصادقة برمز Bearer في ترويسة Authorization، ومفاتيح عدم التكرار (idempotency keys) حتى لا تؤدي إعادة المحاولة إلى رسائل مكررة، وتقسيم القوائم إلى صفحات، وحدود للمعدل مع ترويسات retry-after، واستخدام Webhook للنتائج غير المتزامنة مثل تقارير التسليم.
تناسب REST معظم عمليات التكامل: أنظمة إدارة علاقات العملاء (CRM)، ومنصات التجارة الإلكترونية، وأنظمة المكاتب الخلفية. أما في رسائل SMS ذات الأحجام الكبيرة جداً، فكثيراً ما يستخدم مشغلو الاتصالات ومجمّعو الرسائل بروتوكول SMPP بدلاً منها، إذ يُبقي اتصالاً دائماً مفتوحاً.
تصف مواصفات OpenAPI نقاط النهاية بطريقة قابلة للقراءة آلياً، بحيث يمكن توليد حزم تطوير العملاء (SDK) والوثائق والاختبارات منها.
توفر OmniChannels.ai واجهة REST/JSON API على https://api.broadnet.me مع مصادقة برمز Bearer، ومواصفات OpenAPI 3.1، وحزمة TypeScript SDK.
مثال
POST https://api.broadnet.me/… مع الترويسة "Authorization: Bearer <token>" ومتن JSON؛ وتُعيد الاستجابة معرّف الرسالة.