مرجع API

ابنِ مع SMSBulk

واجهة REST API حديثة ونقاط نهاية متوافقة مع SMS-Activate. ابدأ في دقائق.

أسلوبا API

اختر التنسيق المناسب لمشروعك — كلاهما يعمل بنفس البنية التحتية.

واجهة REST API الحديثة

API نظيف يعتمد على JSON مع مواصفات OpenAPI. مثالي للتكاملات الجديدة.

  • أجسام طلب واستجابة بصيغة JSON
  • مواصفات OpenAPI 3.0 على /api/docs
  • مصادقة Bearer token أو x-api-key
  • أكواد حالة HTTP قياسية
curl https://smsbulk.net/api/v1/wallet/balance \
  -H "x-api-key: YOUR_KEY"

متوافق مع API الموروث

متوافق مع البروتوكول القياسي القائم على query. السكربتات والمكتبات الحالية تعمل دون تغيير الكود — فقط وجّهها إلى عنوان URL الأساسي لدينا.

  • بروتوكول متطابق يعتمد على الإجراءات
  • تنسيق استجابة نصي عادي
  • متوافق مع مكتبات البوتات الحالية
  • تعيين معرف الدولة القانوني محفوظ
curl "https://smsbulk.net/stubs/handler_api.php\
?api_key=YOUR_KEY&action=getBalance"
دليل الترحيل

البدء السريع

من الصفر إلى أول SMS في أقل من 5 دقائق.

1

احصل على مفتاح API

أنشئ مفتاح API من لوحة التحكم. كل مستخدم يمكنه إنشاء ما يصل إلى 10 مفاتيح.

افتح لوحة التحكم
2

اختبر المصادقة

تحقق من عمل المفتاح بفحص رصيد محفظتك.

curl https://smsbulk.net/api/v1/wallet/balance \
  -H "x-api-key: YOUR_KEY"

# Response:
# { "balance": "10.00", "currency": "USD" }
3

اشترِ رقماً

احجز رقماً افتراضياً للتحقق عبر SMS. تخصم التكلفة من محفظتك.

curl -X POST https://smsbulk.net/api/v1/activations \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "serviceCode": "wa",
    "countryIso": "US"
  }'

# Response:
# {
#   "id": "cuid_xxx",
#   "phoneNumber": "12025550147",
#   "status": "WAITING",
#   "userCost": "0.50"
# }
4

انتظر SMS

استعلم نقطة نهاية التفعيل حتى تصبح الحالة RECEIVED. سيكون رمز SMS في الاستجابة.

يُحذف محتوى الرسائل، بما في ذلك الرمز، بعد 30 يومًا من استلامها؛ بعدها يعيد getStatus القيمة NO_ACTIVATION ويعيد v1 الحقل purged: true.

curl https://smsbulk.net/api/v1/activations/cuid_xxx \
  -H "x-api-key: YOUR_KEY"

# Response (when SMS arrives):
# {
#   "id": "cuid_xxx",
#   "smsCode": "123456",
#   "status": "RECEIVED",
#   ...
# }

المصادقة

ثلاث طرق لإرسال مفتاح API.

اختر الطريقة المناسبة لبيئتك

1. Header (موصى به)

x-api-key: YOUR_API_KEY

مصادقة قياسية تعتمد على الترويسة. تعمل مع كل من نقاط نهاية REST و SMS-Activate.

2. Bearer token

Authorization: Bearer YOUR_API_KEY

متوافق مع مكتبات عملاء HTTP التي تستخدم Authorization افتراضياً.

3. Query string

?api_key=YOUR_API_KEY

مطلوب لنقطة نهاية التوافق /stubs/handler_api.php.

احتفظ بمفاتيحك سرية

لا تضع مفاتيح API في مستودعات عامة أو في الكود من جانب العميل. لكل مفتاح حصة يومية — قم بتدويره فوراً إذا تعرض للخطر.

المراجع

جديد على واجهة API؟ ابدأ بالأدلة: API التحقق عبر الرسائل · API الأرقام الافتراضية · دليل Node.js · دليل Python

جاهز للإطلاق؟

افتح مرجع API التفاعلي وجرب كل نقطة نهاية مباشرة في متصفحك.