نظرة عامة على واجهة برمجة تطبيقات Pushwoosh
تسمح واجهة برمجة تطبيقات Pushwoosh للمطورين بالتفاعل مع منصة Pushwoosh.
ماذا يمكنك أن تفعل بواجهة برمجة تطبيقات Pushwoosh؟
Anchor link toمع واجهة برمجة تطبيقات Pushwoosh، يمكنك الوصول إلى مكتبة واسعة تضم أكثر من 100 طريقة تمكنك من:
- إرسال إشعارات دفع مخصصة
- إنشاء واستيراد وتصدير وإدارة شرائح المستخدمين للاستهداف الدقيق
- استخدام واجهات برمجة التطبيقات المجمعة لإدارة المستخدمين/الأجهزة على دفعات
- تكوين التطبيقات
- تتبع أحداث المستخدم وإضافة علامات للمستخدمين لتعزيز الاستهداف والتخصيص
- إنشاء وإدارة كيانات Pushwoosh مثل الإعدادات المسبقة والعلامات والأحداث والتطبيقات، إلخ.
- بدء رحلات عملاء Pushwoosh عبر واجهة برمجة التطبيقات
- استرداد إحصاءات شاملة عن رحلات العملاء وحملات الإشعارات/البريد الإلكتر الإلكتروني/الرسائل القصيرة.
- تنفيذ السياج الجغرافي لإرسال إشعارات قائمة على الموقع عندما يدخل المستخدمون أو يخرجون من مناطق جغرافية محددة
- دمج خدمات الطرف الثالث بسلاسة مع Pushwoosh
لاستكشاف النطاق الكامل للطرق المتاحة واكتشاف القدرات الواسعة لواجهة برمجة تطبيقات Pushwoosh، يرجى الرجوع إلى فهرس مرجع أساليب واجهة برمجة التطبيقات.
المصادقة
Anchor link toتستخدم واجهة برمجة تطبيقات Pushwoosh رموز API لمصادقة الطلبات. هناك نوعان من الرموز: الخادم (Server) و الجهاز (Device)، كل منهما يستخدم لنطاقات API محددة.
يأتي كل حساب Pushwoosh مع رمز وصول API افتراضي تم إنشاؤه لتطبيق Pushwoosh التجريبي. يمكنك عرض وإنشاء وإدارة رموز API الخاصة بك في لوحة تحكم Pushwoosh.
حدود المعدل
Anchor link toحد المعدل هو عدد الطلبات التي يمكن لواجهة برمجة التطبيقات تلقيها في فترة معينة. في حين أن معظم طلبات API في Pushwoosh غير محدودة، فإن طلبات /createMessage وما يعادلها من طلبات Messaging API v2 Notify محددة بـ 600 طلب في الدقيقة لضمان جودة الخدمة لجميع المستخدمين.
الطلبات
Anchor link toHTTPS إلزامي لجميع طلبات API لضمان نقل البيانات بشكل آمن.
الاستجابات
Anchor link toعادةً ما تُرجع واجهة برمجة تطبيقات Pushwoosh استجابات JSON.
رموز النجاح والخطأ
Anchor link toرموز النجاح
Anchor link toعندما تتم معالجة طلب API الخاص بك بنجاح، ستتلقى رمز نجاح كجزء من الاستجابة.
| رمز حالة HTTP | رسالة الحالة | الوصف |
|---|---|---|
| 200 | OK | عالج Pushwoosh الطلب بنجاح |
يرجى ملاحظة أنه عندما تحصل على استجابة HTTP 200، فهذا يعني أن طلبك قد تم فهمه ومعالجته بنجاح، ولكنه لا يضمن نجاح الإجراء. لذا تأكد من التحقق من رسائل الخطأ أو التحذير (تم رفض الوصول، لم يتم العثور على التطبيق، مفتاح API غير صالح، إلخ) لتحديد نجاح الإجراء.
| رمز الحالة | رسالة الحالة |
|---|---|
| 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 واضبطها حسب الحاجة لتتناسب مع متطلبات العملية المحددة التي تريد تنفيذها. |
| 404 | Resource not found | يشير إلى أن المورد المطلوب، مثل تطبيق، لا يمكن تحديد موقعه أو أنه غير موجود على الخادم. |
| 500 | Internal error | حدثت مشكلة أو خطأ غير متوقع على الخادم أثناء معالجة طلب API. |