English

المطوّرون: مفاتيح API والـ Webhooks

اربط متجرك بنظام كاشير أو ERP أو شركة شحن أو تطبيق من تطويرك عبر مفاتيح API وإشعارات فورية.

افتح الصفحة في لوحة التحكم

صفحة المطوّرون لربط متجرك ببرامج أخرى. يديرها صاحب المتجر وحده. في أعلاها رابط الـ API الأساسي وهيدر التوثيق وزر توثيق الـ API الذي يفتح الشرح الكامل لكل الطلبات.

صفحة المطوّرين
صفحة المطوّرين

إنشاء مفتاح API

  1. اضغط مفتاح جديد.
    نافذة المفتاح الجديد
    نافذة المفتاح الجديد
  2. اكتب اسم المفتاح يذكّرك لمن هو (مثل «الكاشير في الفرع»).
  3. اختر الصلاحيات لكل نوع بيانات: المنتجات، والطلبات، والعملاء، والمخزون، والشحنات (قراءة فقط، أو قراءة وكتابة). امنح أقل صلاحيات ممكنة.
  4. اضغط أنشئ المفتاح، ثم انسخه فورًا واحفظه في مكان آمن.

يرسل البرنامج المفتاح مع كل طلب في الهيدر: Authorization: Bearer apx_…

المفتاح يظهر مرة واحدة فقط. إذا فقدته أنشئ مفتاحًا جديدًا. وإذا تسرّب، اضغط إلغاء المفتاح فينقطع الوصول فورًا.

كل مفتاح خاص بهذا المتجر فقط. الحد: 40 طلبًا دفعة واحدة، وطلبان في الثانية لكل مفتاح. ترى بجانب كل مفتاح متى أُنشئ وآخر استخدام له.

الـ Webhooks: إشعارات فورية

نرسل إشعارًا إلى رابطك بمجرد وقوع حدث في متجرك.

  1. اضغط إضافة Webhook.
  2. اكتب رابط الاستقبال (يجب أن يبدأ بـ https://).
  3. اختر الأحداث: طلب جديد، أو تعديل طلب، أو إلغاؤه، أو دفعه، أو إضافة منتج أو تعديله أو حذفه، أو عميل جديد، أو تحديث شحنة.
  4. اضغط إضافة.

كل إشعار موقّع بـ مفتاح التوقيع الظاهر في بطاقة الـ Webhook، في الهيدر X-Apexfy-Hmac-Sha256. تحقّق منه في برنامجك قبل قبول الإشعار. يمكنك إيقاف أي Webhook مؤقتًا أو حذفه.

آخر الإرسالات

أسفل الصفحة آخر 30 إشعارًا أرسلناها وحالة كل منها: تم الإرسال، أو قيد الانتظار، أو فشل. إذا لم يرد رابطك نعيد المحاولة تلقائيًا ونعرض موعد المحاولة التالية.

للربط مع شركات الشحن أو برامج المحاسبة المشهورة، اطلب من مطوّرك قراءة توثيق الـ API أولًا، فكل الطلبات فيه بأمثلة جاهزة.
هل ساعدك هذا الشرح؟