نظرة عامة على واجهة برمجة تطبيقات Pushwoosh
تتيح واجهة برمجة تطبيقات Pushwoosh للمطورين التفاعل مع منصة Pushwoosh.
ماذا يمكنك أن تفعل بواجهة برمجة تطبيقات Pushwoosh؟
Anchor link toباستخدام واجهة برمجة تطبيقات Pushwoosh، يمكنك الوصول إلى مكتبة واسعة تضم أكثر من 100 طريقة تمكنك من:
- إرسال إشعارات Push مخصصة
- إنشاء واستيراد وتصدير وإدارة شرائح المستخدمين (Segments) لاستهداف دقيق
- استخدام واجهات برمجة التطبيقات (APIs) المجمعة لإدارة المستخدمين/الأجهزة على دفعات
- تهيئة التطبيقات
- تتبع أحداث المستخدمين (Events) وإضافة علامات (Tags) للمستخدمين لتعزيز الاستهداف والتخصيص
- إنشاء وإدارة كيانات Pushwoosh مثل الإعدادات المسبقة (presets) والعلامات (tags) والأحداث (events) والتطبيقات، إلخ.
- بدء رحلات عملاء Pushwoosh (Customer Journeys) عبر واجهة برمجة التطبيقات (API)
- استرداد إحصائيات شاملة حول رحلات العملاء (Customer Journeys) وحملات Push/Email/SMS.
- تنفيذ تحديد النطاق الجغرافي (geofencing) لإرسال إشعارات تعتمد على الموقع عندما يدخل المستخدمون أو يغادرون مناطق جغرافية محددة
- دمج خدمات الأطراف الثالثة (3rd party services) بسلاسة مع Pushwoosh
لاستكشاف النطاق الكامل للطرق المتاحة واكتشاف الإمكانات الواسعة لواجهة برمجة تطبيقات Pushwoosh، يرجى الرجوع إلى فهرس مرجع طرق API.
المصادقة
Anchor link toتستخدم واجهة برمجة تطبيقات Pushwoosh رموز API المميزة (API tokens) لمصادقة الطلبات. يوجد نوعان من الرموز المميزة: الخادم (Server) والجهاز (Device)، ويُستخدم كل منهما لنطاقات API محددة.
يأتي كل حساب Pushwoosh مع رمز وصول API مميز افتراضي (default API Access Token) تم إنشاؤه لتطبيق Pushwoosh التجريبي (Demo App). يمكنك عرض وإنشاء وإدارة رموز API المميزة الخاصة بك في لوحة تحكم Pushwoosh (Control Panel).
حدود المعدل
Anchor link toحد المعدل (Rate limit) هو عدد الطلبات التي يمكن لواجهة برمجة التطبيقات (API) تلقيها في فترة زمنية معينة. بينما معظم طلبات API في Pushwoosh غير محدودة، فإن طلبات API الخاصة بـ /createMessage محدودة بـ 600 طلب في الدقيقة لضمان جودة الخدمة لجميع المستخدمين.
الطلبات
Anchor link toبروتوكول HTTPS إلزامي لجميع طلبات API لضمان نقل آمن للبيانات.
الاستجابات
Anchor link toتُرجع واجهة برمجة تطبيقات Pushwoosh عادةً استجابات JSON.
رموز النجاح والأخطاء
Anchor link toرموز النجاح
Anchor link toعندما تتم معالجة طلب API الخاص بك بنجاح، ستتلقى رمز نجاح كجزء من الاستجابة.
| رمز حالة HTTP | رسالة الحالة | الوصف |
|---|---|---|
| 200 | OK | عالجت Pushwoosh الطلب بنجاح |
يرجى ملاحظة أنه عندما تتلقى استجابة HTTP 200، فهذا يعني أن طلبك قد تم فهمه ومعالجته بنجاح، لكنه لا يضمن نجاح الإجراء. لذا تأكد من التحقق من رسائل الخطأ أو التحذير (مثل access denied, application not found, invalid API key, إلخ) لتحديد نجاح الإجراء.
| رمز الحالة | رسالة الحالة |
|---|---|
| 200 | تحذيرات: لقد وصلت إلى حد المشتركين (subscriber limit). سيتم إرسال رسالة Push إلى جهاز عشوائي واحد فقط. |
| 200 | تحذيرات: لقد تجاوزت عدد الأجهزة النشطة المسموح بها في خطة اشتراكك الحالية (subscription plan). |
| 210 | تم رفض الوصول (Access denied) أو لم يتم العثور على التطبيق (application not found) |
| 210 | لم يتم العثور على التطبيق (Application not found) |
| 210 | التطبيق معلق (Application suspended) |
| 210 | لم يتم العثور على الحساب (Account not found) |
| 210 | تم تعليق الحساب (Account has been suspended) |
| 210 | لا يمكن للحساب المعلق استخدام تصفية الأجهزة (device filtration) |
| 210 | رمز API المميز (API token) أو التطبيق غير مضبوط |
| 210 | الرجاء تحديد منصة واحدة على الأقل (platform) |
| 210 | رمز API المميز غير صالح (Invalid API Token): لم يتم العثور على الحساب (Account not found) |
| 210 | لم يتم تقديم تطبيق أو رمز مجموعة (group code) |
| 210 | رمز API المميز (API token) أو التطبيق أو الحساب غير مضبوط |
رموز الأخطاء
Anchor link toفي حال لم يتم تنسيق طلبك بشكل صحيح، أو واجه مشاكل في المعالجة، أو تعرض لأي أخطاء أخرى، سترسل لك Pushwoosh رمز خطأ يشير إلى طبيعة المشكلة، مما يساعدك على استكشاف الأخطاء وإصلاحها ومعالجة المشكلة بفعالية.
| رمز حالة HTTP | رسالة الحالة | الوصف |
|---|---|---|
| 400 | طلب سيء (Bad request) | لا يمكن تلبية الطلب بسبب سوء التنسيق (bad syntax) |
| 401 | غير مصرح به (Unauthorized) | فشلت المصادقة أو لم يتم تقديمها |
| 403 | قيود الرمز المميز (Token restrictions) تمنع هذه العملية. | رمز الوصول المميز (access token) الخاص بك يفتقر إلى الأذونات اللازمة (permissions) لتنفيذ الإجراء المطلوب. لإصلاح ذلك، راجع أذونات رمز الوصول المميز الخاص بك في لوحة تحكم Pushwoosh (control panel) وقم بتعديلها حسب الحاجة لتتوافق مع متطلبات العملية المحددة التي ترغب في تنفيذها. |
| 404 | المورد غير موجود (Resource not found) | يشير إلى أن المورد المطلوب، مثل تطبيق (app)، لا يمكن العثور عليه أو لا يوجد على الخادم (server). |
| 500 | خطأ داخلي (Internal error) | حدثت مشكلة غير متوقعة أو خطأ في الخادم (server) أثناء معالجة طلب API. |