API Access token

يعد API Access Token معرفاً فريداً يتم تعيينه لمشروع معين أو عدة مشاريع في حسابك. يقوم بمصادقة حسابك لإدارة مشاريعك عبر API، بما في ذلك تعديلات الحساب، وإرسال الرسائل، وتحرير المشاريع، وما إلى ذلك.

أنواع API Access token

توفر Pushwoosh نوعين مختلفين من API Access Token: Server و Device.

كل نوع رمز صالح فقط لنطاق API الخاص به. سيحدث خطأ في المصادقة إذا تم استخدام الرمز غير الصحيح.

Server API token

يستخدم Server API token مع جميع طرق API، باستثناء تلك الموجودة تحت Device API. يجب تضمينه في جسم الطلب (request body) في الحقل auth.

Device API token

يستخدم Device API token حصرياً مع طرق Device API. يجب تضمينه في ترويسات طلب HTTP (HTTP request headers) باستخدام الترويسة Authorization. أدناه مثال على تنسيق الترويسة الصحيح:

Authorization: Token <device_api_token>

استبدل \<device_api_token\> بقيمة Device API Token الفعلية الخاصة بك.

طرق تتطلب Device API token

طرق API التالية تتطلب Device API token للمصادقة:

• registerDevice
• unregisterDevice
• setTags
• getTags
• setBadge
• applicationOpen
• pushStat
• messageDeliveryEvent
• registerUser
• postEvent
• registerEmail
• deleteEmail
• setEmailTags
• registerEmailUser
• getInboxMessages
• inboxStatus

إنشاء وإدارة API Access tokens

يمكنك عرض، وإنشاء، وإدارة API Access tokens الخاصة بك في قسم API Access في Pushwoosh Control Panel. للوصول إليه، انتقل إلى Settings ← API Access.

افتراضياً، يتضمن كل حساب رمزاً يسمى Pushwoosh Demo App، والذي تم إعداده كرمز خادم (server token).

إنشاء API Access token جديد

لإنشاء API Access token جديد:

1. انتقل إلى قسم API Access في Control Panel.

2. انقر على Generate New Token.

3. في النافذة التي تظهر، اختر نوع الرمز:

   • Server يستخدم لمعظم طرق API (باستثناء طرق Device API).

   • Device يستخدم لطرق Device API فقط.

4. أدخل اسماً للرمز.

5. انقر على Generate لإنشاء الرمز.

هام: تأكد من منح الرمز حق الوصول إلى التطبيق الصحيح في Pushwoosh Control Panel. اعرف المزيد

سيظهر الرمز الجديد في قائمة API Access. من هناك، يمكنك نسخ قيمته لاستخدامها في طلبات API أو إدارة أذونات الوصول الخاصة به حسب الحاجة.

إدارة الرمز

لإدارة API token موجود، انقر على قائمة النقاط الثلاث (⋮) بجوار إدخال الرمز في قسم API Access.

الخيارات التالية متاحة:

منح الوصول لجميع المشاريع (Grant access to all projects)

يمنح الرمز حق الوصول إلى جميع المشاريع في حسابك. هذا يسمح له باستخدام API بالكامل عبر جميع المشاريع.

نصيحة

امنح الوصول الكامل فقط للرموز التي تحتاج إليه. هذا يساعد في الحفاظ على أمان بياناتك والتحكم في الوصول.

إلغاء الوصول من جميع المشاريع (Revoke access from all projects)

يزيل وصول الرمز إلى جميع المشاريع في حسابك. لن يتمكن الرمز من استخدام API حتى يتم منح الوصول مرة أخرى.

تعديل الرمز (Edit token)

يفتح شاشة Edit API Token Permissions، حيث يمكنك:

• تغيير اسم الرمز

• نسخ قيمة الرمز

• اختيار المشاريع التي يمكن للرمز الوصول إليها عن طريق تحديدها أو إلغاء تحديدها في القائمة

بعد الانتهاء من إجراء التغييرات، انقر على Save لتطبيقها.

نصيحة

امنح الرموز حق الوصول فقط إلى المشاريع التي تحتاجها. هذا يساعد في حماية حسابك والتحكم فيما يمكن لكل رمز فعله.

حذف الرمز (Delete token)

يزيل الرمز نهائياً من حسابك.

تنبيه

لا يمكن التراجع عن هذا الإجراء. بمجرد الحذف، لا يمكن استعادة الرمز. تأكد من أن الرمز لم يعد قيد الاستخدام قبل حذفه.

تخويل طلبات API

لتخويل طلبات API، استخدم النوع الصحيح من API Access token بناءً على نوع طريقة API التي تستدعيها:

بالنسبة لطرق Server API

قم بتضمين الرمز في الحقل “auth” في جسم الطلب (request body):

مثال:

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // الصق رمز الخادم الخاص بك هنا
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

بالنسبة لطرق Device API

استخدم Device token. قم بتضمينه في ترويسة طلب HTTP باستخدام التنسيق التالي:

Authorization: Token <device_api_token>

استبدل \<device_api_token\> بقيمة الرمز الفعلية الخاصة بك.

تنبيه

تأكد من أن نوع الرمز يطابق طريقة API التي تستخدمها. إذا لم يطابق الرمز النوع المطلوب، فسيعيد الطلب خطأ في المصادقة.