خدمات Non-VoIP

دليل شامل لاستخدام واجهة برمجة التطبيقات API في Non-VoIP

4 دقائق قراءة
دليل شامل لاستخدام واجهة برمجة التطبيقات API في Non-VoIP
مشاركة

توفر منصة Non-VoIP لوحة تحكم متطورة لواجهة برمجة التطبيقات (API Dashboard) تتيح للمطورين وأصحاب المشاريع أتمتة عمليات طلب الأرقام واستقبال أكواد الـ SMS برمجياً.

لكن لاستخدام واجهة برمجة التطبيقات API في Non-VoIP، يجب أن يكون حسابك مؤهلاً للوصول عبر وصول إجمالي عمليات الشحن التراكمية في حسابك إلى 250 دولاراً، لتتحول شارة حالة الـ API إلى اللون الأخضر (متاح).

استخدام واجهة برمجة التطبيقات API في Non-VoIP؟

استخدام واجهة برمجة التطبيقات API في Non-VoIP؟

تم تصميم لوحة تحكم الـ API في منصة Non-VoIP لتجمع بين القوة التقنية وسهولة الاستخدام، مما يتيح لك ربط خدمات المنصة بأنظمتك الخاصة بكل سلاسة. للوصول إلى هذه اللوحة، ما عليك سوى النقر على تبويب (API) الموجود في الشريط العلوي للمنصة.

إليك شرح مبسط وشامل لقسم الـ API:

شرط التفعيل: شارة حالة الـ API

شرط التفعيل: شارة حالة الـ API

قبل البدء، انظر إلى الزاوية اليمنى من الشاشة حيث يوجد قسم (حالة API). ستلاحظ وجود شارة توضح حالة توفر الخدمة (REST API متاح).

  • الشارة الخضراء (متاح): تعني أن حسابك مؤهل تماماً لاستخدام الـ API.

  • الشارة الحمراء (غير متاح): تعني أن الميزة لم تُفعل بعد. يتطلب تفعيل هذه الميزة أن يصل إجمالي مبالغ الشحن في حسابك إلى 250 دولاراً.

1. قسم نظرة عامة (Overview)

t2ap5UROcv.png

هذا التبويب هو مركز المراقبة الخاص بك. من هنا يمكنك متابعة أداء عملياتك البرمجية لحظة بلحظة:

  • إحصائيات الطلبات (Requests): يعرض لك إجمالي الطلبات اليومية، نسبة النجاح (Successful)، ونسبة الفشل (Failed)، بالإضافة إلى سرعة الاستجابة (التي تصل إلى أجزاء من الثانية).

  • حالة النظام (System Operational): مؤشرات خضراء تطمئنك بأن البوابة، خدمة الرسائل، ومُرسل الإشعارات تعمل بكفاءة تامة.

  • حدود الاستخدام (API Rate Limits): يوضح لك الحد الأقصى للطلبات المسموح بها في الدقيقة (مثلاً: 60 طلب/دقيقة). إذا كان مشروعك يتطلب وتيرة أسرع، يمكنك النقر على زر (طلب رفع الحد) لطلب رفع هذا الحد من الدعم الفني.

2. إدارة المفاتيح والأمان (Keys)

إدارة المفاتيح والأمان (Keys)

هذا القسم هو مفتاح الدخول الآمن لأنظمتك:

  • مفتاح الوصول (API Key): هو الرمز السري الذي ستضعه في الكود البرمجي الخاص بك للسماح له بالتخاطب مع منصة Non-VoIP. يمكنك النقر على أيقونة النسخ المجاورة له.

  • تجديد المفتاح (Regenerate Key): زر هام جداً للأمان. إذا شعرت أن مفتاحك قد تم تسريبه، انقر هنا لتوليد مفتاح جديد فوراً وإلغاء القديم.

  • مفتاح الاختبار (View Test Key): يتيح لك استعراض مفتاح خاص ببيئة التجارب (Test Mode)، والذي يسمح لك بتجربة الأكواد دون خصم أي رصيد حقيقي.

  • قائمة عناوين IP المسموحة (IP Allowlist): لزيادة الأمان، يمكنك النقر على (إضافة IP) لإضافة عناوين الإنترنت (IPs) الخاصة بخوادمك فقط لمنع أي جهاز آخر من استخدام الـ API الخاص بك حتى لو امتلك المفتاح السري.

3. الإشعارات اللحظية (Webhooks)

Webhooks

بدلاً من أن يقوم التطبيق بسؤال المنصة باستمرار "هل وصل الكود؟"، تقوم الـ Webhooks بإرسال الكود فور وصوله مباشرة:

  • رابط ويب هوك (Webhook URL): هنا تضع الرابط الخاص بموقعك أو تطبيقك الذي سيستقبل الإشعارات.

  • أنواع الأحداث (Event Types): يمكنك تحديد مربعات الاختيار للأحداث التي تهمك فقط، مثل: اكتمل التحقق (Verification Completed)، أو استلام  الكود (OTP Received)، أو انتهاء التحقق (Verification Expired).

  • إرسال حدث تجريبي (Send Test Event): بعد إعداد الرابط، انقر على هذا الزر ليقوم النظام بإرسال بيانات تجريبية للتأكد من أن الربط يعمل بشكل سليم.

4. المستندات والتجربة العملية (API Documentation)

المستندات والتجربة العملية

لتسهيل عمل المبرمجين، توفر المنصة أدوات متكاملة:

الوثائق الكاملة (Full Documentation)

الوثائق الكاملة

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

ميزة المساعد الذكي (Ask AI):

  • في صفحة المستندات، ستجد زراً في الأعلى باسم (اسأل الذكاء الاصطناعي). عند النقر عليه، ستظهر لك قائمة تتيح لك سؤال نماذج الذكاء الاصطناعي مباشرة (اسال Claude أو اسأل ChatGPT) عن أي استفسار يخص أكواد المنصة

  • كما يمكنك نسخ المستندات بتنسيق (Markdown) بضغطة زر، حيث أن هذه الميزة توفر ساعات من البحث على المطورين.

مجموعة Swagger (Swagger Collection)

بيئة بصرية تتيح لك تجربة الأوامر البرمجية (مثل طلب رقم، استعراض الدول) مباشرة من المتصفح لمعرفة شكل الاستجابة قبل كتابة أي كود.

في الختام

من خلال لوحة تحكم الـ API في منصة Non-VoIP، أنت تمتلك بيئة متكاملة تجمع بين سهولة التخصيص، الأمان العالي عبر القوائم البيضاء، والذكاء في توفير الإشعارات اللحظية.

وبفضل توفر أدوات متقدمة مثل ميزة المساعد الذكي ووضع التجربة ، أصبح بإمكان المطورين دمج خدمات المنصة في مشاريعهم خلال دقائق معدودة. تأكد من استيفاء شرط الشحن (250$)، وانطلق نحو أتمتة أعمالك.

التعليقات