Postman وInsomnia
جرّب الواجهة البرمجية من Postman أو Insomnia دون كتابة شيفرة. تغطي المجموعتان الطلبات نفسها: إرسال رسالة وقراءة سجلها الزمني، ثم مجموعات الأجهزة وعمليات التحقق وجهات الاتصال والقوالب والحملات وخطافات الويب والقائمة السوداء وباقتك.
- تنزيل مجموعة Postman (
smsfabric.postman_collection.json, Collection v2.1) - تنزيل مجموعة Insomnia (
smsfabric.insomnia.json, v4 export)
22 طلبًا جاهزًا بالترتيب الذي تجربها به، من أول إرسال إلى الحملات وخطافات الويب وباقتك.
تُنشأ الملفات مع كل بناء للوثائق، ويُتحقق من كل طلب فيها مقابل عقد الواجهة البرمجية، فتطابق هذا المرجع.
قبل أن تبدأ
Section titled “قبل أن تبدأ”- اربط هاتفا، أو استخدم مفتاحا تجريبيا. المفتاح الذي يبدأ بـ
sf_test_يرسل عبر بيئة الاختبار، فلا تخرج أي رسالة من أي هاتف. - أنشئ مفتاح API بالصلاحيات التي تحتاجها المجلدات التي ستشغلها. تكفي
messages:sendوmessages:readللمجلد الأول.
Postman
Section titled “Postman”-
اضغط Import وأفلت الملف
smsfabric.postman_collection.json. -
افتح المجموعة، وانتقل إلى Variables، واضبط
apiKeyفي عمود Current value. تبقى القيم الحالية على جهازك، أما القيم الأولية فتُزامن مع مساحة عملك. -
شغّل Messages › Send a message. الرد
201معstatus: "queued"يعني أن الرسالة في طريقها إلى هاتف.
يرسل كل طلب X-Api-Key: {{apiKey}}. وتضيف طلبات الإرسال Idempotency-Key: {{$guid}}، فلا تؤدي إعادة المحاولة بالمفتاح نفسه إلى إرسال مرتين (منع التكرار).
بعد طلب إنشاء، يحفظ Postman المعرف الجديد للطلبات التالية:
| المتغير | يضبطه |
|---|---|
messageId |
Send a message، وSend through a pool، وSchedule a message |
poolId |
Create a pool |
verificationId |
Send a code |
templateId |
Create a template |
campaignId |
Create a campaign |
webhookId |
Create a webhook |
scheduledAt |
يُضبط على ساعة من الآن قبل تشغيل Schedule a message |
Insomnia
Section titled “Insomnia”-
اضغط Import، واختر From file، ثم اختر
smsfabric.insomnia.json. -
افتح Manage environments، واختر Base Environment، واضبط
apiKey. -
شغّل Messages › Send a message.
لا يحفظ Insomnia المعرفات من الردود. انسخ id من الرد إلى متغير البيئة المقابل (messageId أو poolId أو verificationId أو templateId أو campaignId أو webhookId) قبل تشغيل طلب يستخدمه. وفي Schedule a message اضبط scheduledAt على وقت قادم بتوقيت UTC بالصيغة YYYY-MM-DDTHH:MM:SSZ.
المتغيرات
Section titled “المتغيرات”| المتغير | القيمة |
|---|---|
baseUrl |
https://api.smsfabric.com |
apiKey |
مفتاح API الخاص بك. فارغ في الملفين. |
غيّر هذه قبل التشغيل
Section titled “غيّر هذه قبل التشغيل”- Check a code: ضع مكان
123456الأرقام التي وصلت إلى الهاتف. - Create a webhook: ضع عنوان HTTPS الخاص بك مكان
https://example.com/hooks/smsfabric. - Send through a pool: أضف هاتفا واحدا على الأقل إلى مجموعة الأجهزة أولا، عبر
PATCH /v1/devices/:idمع{ "poolId": "…" }. - Create a campaign ينشئ مسودة لجهات الاتصال الموسومة
vip. لا يُرسل شيء حتى تستدعيPOST /v1/campaigns/:id/start، وقد تُرك هذا الطلب خارج المجموعة عمدا. - نص القالب مثل
{{first_name|there}}هو صيغة المتغيرات الخاصة بـ SMSFabric ويُرسل كما هو. في Postman لا تنشئ متغيرا باسمfirst_name، وإلا ملأه Postman قبل خروج الطلب.