نظرة عامة على Pushwoosh API
يتيح Pushwoosh API للمطورين التفاعل مع منصة Pushwoosh.
ماذا يمكنك أن تفعل باستخدام Pushwoosh API؟
Anchor link toباستخدام Pushwoosh API، يمكنك الوصول إلى مكتبة واسعة تضم أكثر من 100 طريقة تمكنك من:
- إرسال إشعارات Push مخصصة
- إنشاء واستيراد وتصدير وإدارة شرائح المستخدمين للاستهداف الدقيق
- استخدام واجهات برمجة التطبيقات المجمعة لإدارة المستخدمين/الأجهزة على دفعات
- تهيئة التطبيقات
- تتبع أحداث المستخدمين وإضافة علامات (Tags) للمستخدمين لتعزيز الاستهداف والتخصيص
- إنشاء وإدارة كيانات Pushwoosh مثل الإعدادات المسبقة (presets)، العلامات (tags)، الأحداث (events)، التطبيقات، إلخ.
- بدء رحلات العملاء (Customer Journeys) من Pushwoosh عبر API
- استرداد إحصائيات شاملة حول رحلات العملاء (Customer Journeys) وحملات Push/البريد الإلكتروني/الرسائل القصيرة (SMS Campaigns).
- تطبيق التسييج الجغرافي (geofencing) لإرسال إشعارات تعتمد على الموقع عندما يدخل المستخدمون أو يغادرون مناطق جغرافية محددة
- دمج خدمات الجهات الخارجية (3rd party services) بسلاسة مع Pushwoosh
لاستكشاف النطاق الكامل للطرق المتاحة واكتشاف الإمكانيات الواسعة لـ Pushwoosh API، يرجى الرجوع إلى فهرس مرجع طرق API.
المصادقة
Anchor link toيستخدم Pushwoosh API رموز API (API tokens) لمصادقة الطلبات. هناك نوعان من الرموز: رمز الخادم (Server API token) و رمز الجهاز (Device API token)، ويُستخدم كل منهما لنطاقات API محددة.
يأتي كل حساب Pushwoosh مع رمز وصول API افتراضي (default API Access Token) تم إنشاؤه لتطبيق Pushwoosh التجريبي (Demo App). يمكنك عرض وإنشاء وإدارة رموز API الخاصة بك في لوحة تحكم Pushwoosh (Control Panel).
حدود المعدل (Rate limits)
Anchor link toحد المعدل (Rate limit) هو عدد الطلبات التي يمكن أن يتلقاها API في فترة زمنية معينة. بينما لا تخضع معظم طلبات API في Pushwoosh للقيود، فإن طلبات API الخاصة بـ /createMessage محددة بـ 600 طلب في الدقيقة لضمان جودة الخدمة لجميع المستخدمين.
الطلبات
Anchor link toبروتوكول HTTPS إلزامي لجميع طلبات API لضمان نقل البيانات بشكل آمن.
الاستجابات
Anchor link toيعيد Pushwoosh API عادةً استجابات بصيغة JSON.
رموز النجاح والأخطاء
Anchor link toرموز النجاح
Anchor link toعندما تتم معالجة طلب API الخاص بك بنجاح، ستتلقى رمز نجاح كجزء من الاستجابة.
| رمز حالة HTTP | رسالة الحالة | الوصف |
|---|---|---|
| 200 | OK | قام Pushwoosh بمعالجة الطلب بنجاح |
يرجى ملاحظة أنه عندما تتلقى استجابة HTTP 200، فهذا يعني أن طلبك قد تم فهمه ومعالجته بنجاح، ولكنه لا يضمن نجاح الإجراء. لذا تأكد من التحقق من رسائل الخطأ أو التحذير (مثل access denied، application not found، invalid API key، إلخ) لتحديد نجاح الإجراء.
| رمز الحالة | رسالة الحالة |
|---|---|
| 200 | Warnings: You have reached the subscriber limit. Push Message will be sent to 1 random device only |
| 200 | Warnings: You have exceeded the number of active devices allowed on your current subscription plan. |
| 210 | Access denied or application not found |
| 210 | Application not found |
| 210 | Application suspended |
| 210 | Account not found |
| 210 | Account has been suspended |
| 210 | Suspended account can not use device filtration |
| 210 | API token or application is not set |
| 210 | Please select at least one platform |
| 210 | Invalid API Token: Account not found |
| 210 | No application or group code given |
| 210 | API token or application or account is not set |
رموز الأخطاء
Anchor link toفي حال لم يكن طلبك منسقًا بشكل صحيح، أو واجه مشكلات في المعالجة، أو تعرض لأي أخطاء أخرى، سيرسل لك Pushwoosh رمز خطأ يشير إلى طبيعة المشكلة، مما يساعدك على استكشاف الأخطاء وإصلاحها ومعالجة المشكلة بفعالية.
| رمز حالة HTTP | رسالة الحالة | الوصف |
|---|---|---|
| 400 | Bad request | لا يمكن تلبية الطلب بسبب سوء التنسيق |
| 401 | Unauthorized | فشلت المصادقة أو لم يتم توفيرها |
| 403 | Token restrictions forbid this operation. | يفتقر رمز الوصول الخاص بك إلى الأذونات اللازمة لتنفيذ الإجراء المطلوب. لإصلاح ذلك، راجع أذونات رمز الوصول الخاص بك في لوحة تحكم Pushwoosh (Control Panel) واضبطها حسب الحاجة لتتوافق مع متطلبات العملية المحددة التي ترغب في تنفيذها. |
| 404 | Resource not found | يشير إلى أن المورد المطلوب، مثل تطبيق، لا يمكن العثور عليه أو لا يوجد على الخادم. |
| 500 | Internal error | حدثت مشكلة غير متوقعة أو خطأ على الخادم أثناء معالجة طلب API. |