نظرة عامة على واجهة برمجة تطبيقات Pushwoosh
تسمح واجهة برمجة تطبيقات Pushwoosh للمطورين بالتفاعل مع منصة Pushwoosh.
ماذا يمكنك أن تفعل بواجهة برمجة تطبيقات Pushwoosh؟
Anchor link toباستخدام واجهة برمجة تطبيقات Pushwoosh، يمكنك الوصول إلى مكتبة واسعة تضم أكثر من 100 طريقة تمكنك من:
- إرسال إشعارات الدفع المخصصة
- إنشاء واستيراد وتصدير وإدارة شرائح المستخدمين للاستهداف الدقيق
- استخدام واجهات برمجة التطبيقات المجمعة لإدارة المستخدمين/الأجهزة على دفعات
- تكوين التطبيقات
- تتبع أحداث المستخدمين وإضافة علامات للمستخدمين لتعزيز الاستهداف والتخصيص
- إنشاء وإدارة كيانات Pushwoosh مثل الإعدادات المسبقة والعلامات والأحداث والتطبيقات وما إلى ذلك.
- بدء رحلات عملاء Pushwoosh عبر واجهة برمجة التطبيقات
- استرداد إحصائيات شاملة حول رحلات العملاء وحملات الدفع/البريد الإلكتروني/الرسائل القصيرة.
- تطبيق تحديد المناطق الجغرافية لإرسال إشعارات تستند إلى الموقع عندما يدخل المستخدمون أو يخرجون من مناطق جغرافية محددة
- دمج خدمات الجهات الخارجية بسلاسة مع Pushwoosh
لاستكشاف النطاق الكامل للطرق المتاحة واكتشاف الإمكانيات الواسعة لواجهة برمجة تطبيقات Pushwoosh، يرجى الرجوع إلى فهرس مرجع طرق واجهة برمجة التطبيقات.
المصادقة
Anchor link toتستخدم واجهة برمجة تطبيقات Pushwoosh رموز API للمصادقة على الطلبات. هناك نوعان من الرموز: الخادم و الجهاز، ويستخدم كل منهما لنطاقات API محددة.
يأتي كل حساب Pushwoosh مع رمز وصول API افتراضي تم إنشاؤه لتطبيق Pushwoosh التجريبي. يمكنك عرض وإنشاء وإدارة رموز API الخاصة بك في لوحة تحكم Pushwoosh.
حدود المعدل
Anchor link toحد المعدل هو عدد الطلبات التي يمكن لواجهة برمجة التطبيقات تلقيها في فترة زمنية معينة. بينما لا تكون معظم طلبات واجهة برمجة التطبيقات في Pushwoosh محدودة، فإن طلبات واجهة برمجة التطبيقات /createMessage محددة بـ 600 طلب في الدقيقة لضمان جودة الخدمة لجميع المستخدمين.
الطلبات
Anchor link toبروتوكول HTTPS إلزامي لجميع طلبات واجهة برمجة التطبيقات لضمان نقل البيانات بشكل آمن.
الاستجابات
Anchor link toعادةً ما تُرجع واجهة برمجة تطبيقات Pushwoosh استجابات JSON.
رموز النجاح والخطأ
Anchor link toرموز النجاح
Anchor link toعند معالجة طلب واجهة برمجة التطبيقات الخاص بك بنجاح، ستتلقى رمز نجاح كجزء من الاستجابة.
| رمز حالة HTTP | رسالة الحالة | الوصف |
|---|---|---|
| 200 | موافق | عالجت Pushwoosh الطلب بنجاح |
يرجى ملاحظة أنه عندما تتلقى استجابة HTTP 200، فهذا يعني أن طلبك قد تم فهمه ومعالجته بنجاح، ولكنه لا يضمن نجاح الإجراء. لذا تأكد من التحقق من رسائل الخطأ أو التحذير (تم رفض الوصول، التطبيق غير موجود، مفتاح API غير صالح، وما إلى ذلك) لتحديد نجاح الإجراء.
| رمز الحالة | رسالة الحالة |
|---|---|
| 200 | تحذيرات: لقد وصلت إلى حد المشتركين. سيتم إرسال رسالة الدفع إلى جهاز عشوائي واحد فقط |
| 200 | تحذيرات: لقد تجاوزت عدد الأجهزة النشطة المسموح بها في خطة اشتراكك الحالية. |
| 210 | تم رفض الوصول أو التطبيق غير موجود |
| 210 | التطبيق غير موجود |
| 210 | التطبيق معلق |
| 210 | الحساب غير موجود |
| 210 | تم تعليق الحساب |
| 210 | لا يمكن للحساب المعلق استخدام تصفية الأجهزة |
| 210 | لم يتم تعيين رمز API أو التطبيق |
| 210 | الرجاء تحديد منصة واحدة على الأقل |
| 210 | رمز API غير صالح: الحساب غير موجود |
| 210 | لم يتم توفير تطبيق أو رمز مجموعة |
| 210 | لم يتم تعيين رمز API أو التطبيق أو الحساب |
رموز الخطأ
Anchor link toفي حال لم يتم تنسيق طلبك بشكل صحيح، أو واجه مشاكل في المعالجة، أو تعرض لأي أخطاء أخرى، سترسل لك Pushwoosh رمز خطأ يشير إلى طبيعة المشكلة، مما يساعدك على استكشاف المشكلة وإصلاحها ومعالجتها بفعالية.
| رمز حالة HTTP | رسالة الحالة | الوصف |
|---|---|---|
| 400 | طلب سيء | لا يمكن تلبية الطلب بسبب سوء التنسيق |
| 401 | غير مصرح به | فشلت المصادقة أو لم يتم توفيرها |
| 403 | قيود الرمز تمنع هذه العملية. | رمز الوصول الخاص بك يفتقر إلى الأذونات اللازمة لأداء الإجراء المطلوب. لإصلاح ذلك، راجع أذونات رمز الوصول الخاص بك في لوحة تحكم Pushwoosh واضبطها حسب الحاجة لتتناسب مع متطلبات العملية المحددة التي ترغب في تنفيذها. |
| 404 | المورد غير موجود | يشير إلى أن المورد المطلوب، مثل تطبيق، لا يمكن العثور عليه أو لا يوجد على الخادم. |
| 500 | خطأ داخلي | حدثت مشكلة أو خطأ غير متوقع على الخادم أثناء معالجة طلب واجهة برمجة التطبيقات. |