اختبار واجهة API محليًا
كيفية استقبال استدعاءات الجهاز على جهاز التطوير واختبار أوامر REST باستخدام Postman قبل النشر.
الاختبار محليًا (دون النشر على خادم)
لاختبار تكامل Callback من جهاز التطوير المحلي — دون النشر على خادم إنتاج — عليك جعل جهازك المحلي متاحًا من الإنترنت ليتمكن Cams Protocol Engine من إرسال بيانات Callback إليه بطلب POST.
الخيار A: IP عام + إعادة توجيه المنافذ
إذا كان اتصالك بالإنترنت يملك عنوان IP عامًا (ثابتًا)، يمكنك إعادة توجيه منفذ خارجي إلى تطبيقك المحلي.
اعرف عنوان IP العام لديك
زر whatismyip.com أو نفّذ curl ifconfig.me في الطرفية. دوّن عنوان IP العام لديك.
اضبط إعادة توجيه المنافذ في الراوتر
سجّل الدخول إلى لوحة إدارة الراوتر. وجّه منفذًا خارجيًا (مثل 8080) إلى عنوان IP الداخلي لجهازك المحلي والمنفذ الذي يعمل عليه تطبيقك (مثل 3000 أو 5000 أو 8080).
اضبط Callback URL
في API Monitor، اضبط Callback URL على:http://YOUR_PUBLIC_IP:8080/callback
اختبر
أطلق بصمة على الجهاز البيومتري. سيرسل Cams Protocol Engine بيانات Callback بطلب POST إلى عنوان IP العام لديك، والذي يوجّهه الراوتر إلى تطبيقك المحلي.
الخيار B: أدوات النفق (دون الحاجة إلى IP عام)
إذا لم يكن لديك IP عام أو تعذّر ضبط إعادة توجيه المنافذ، فاستخدم خدمة نفق (tunneling) لإتاحة خادمك المحلي على الإنترنت.
| الأداة | الأمر | ملاحظات |
|---|---|---|
| ngrok | ngrok http 3000 | تتوفر فئة مجانية. تمنحك عنوان HTTPS عامًا فورًا. |
| Cloudflare Tunnel | cloudflared tunnel --url localhost:3000 | مجاني. لا حاجة لحساب في الأنفاق السريعة. |
| localhost.run | ssh -R 80:localhost:3000 ssh.localhost.run | لا يحتاج تثبيتًا. يعمل عبر SSH. |
شغّل تطبيقك المحلي
شغّل خادم Callback محليًا (مثل php -S localhost:8080 أو node server.js أو python app.py).
شغّل النفق
شغّل أداة النفق. ستعرض عنوانًا عامًا مثل https://abc123.ngrok-free.app.
اضبط Callback URL
في API Monitor، اضبط Callback URL على عنوان النفق:https://abc123.ngrok-free.app/callback
اختبر
أطلق بصمة. ستتدفق استدعاءات Callback عبر النفق إلى جهازك المحلي لحظيًا.
اختبار عنوان URL
قبل الإطلاق، تحقق من نقاطك باستخدام Postman. نوفّر مجموعة جاهزة بجميع عمليات RESTful الـ27 مضبوطة مسبقًا.
مجموعة Postman
نزّلها واستوردها في Postman. اضبط المتغيرات base_url وstgid وauth_token — ثم ابدأ الاختبار فورًا.
استورد المجموعة
افتح Postman → Import → اسحب ملف .json الذي نزّلته وأفلته. تظهر جميع عمليات RESTful الـ27 مجمّعة حسب الفئة.
اضبط المتغيرات
انتقل إلى تبويب Variables في المجموعة واضبط:
base_url = عنوان RESTful endpoint (من API Monitor)
stgid = Service Tag ID لجهازك
auth_token = AuthToken لجهازك
أرسل الطلبات
اختر أي عملية، وعدّل جسم JSON بقيمك، واضغط Send. تحقق من أن الاستجابة تطابق الصيغة المتوقعة الموثّقة أعلاه.
مثال Postman
فيما يلي لقطة شاشة لطلب API نموذجي مضبوط في Postman. اضبط الطريقة على POST، والصق عنوان RESTful endpoint مع ?stgid=، واستخدم جسم raw JSON.
{"status":"done"} مع HTTP 200.