إنتقل إلى المحتوى الرئيسي

مفاتيح API

مفتاح API يربط نظامك، أو نظام شريك تقني يعمل معك، بمنصة نَسَم عبر واجهة نَسَم للمطورين (MM-API).

ما هو المفتاح​

المفتاح يعمل بوصولك أنت: البراندات التي تصل إليها وصلاحيات حسابك، وتقرأ المنصة صلاحياتك عند كل طلب. فإن تغيّر وصولك تغيّر وصوله، وإن توقف حسابك أو خرج من المؤسسة توقفت مفاتيحه. وينشئ كل مستخدم مفاتيحه من حسابه، ولا يرى غيرها.

إنشاء مفتاح​

  1. من القائمة الجانبية في المنصة، تحت «الربط»، افتح «مفاتيح API».
  2. اضغط «أنشئ مفتاح».
  3. سمِّ المفتاح باسم النظام الذي سيستخدمه، مثل «مزامنة نظام ERP»، لتميزه حين تسحبه.
  4. اضغط «أنشئ المفتاح».

نسخ المفتاح​

يظهر المفتاح كاملاً مرة واحدة، بعد إنشائه مباشرة.

  1. اضغط «انسخ المفتاح».
  2. احفظه في مكان آمن، مثل مدير الأسرار في نظامك، أو سلّمه للمطور الذي يبني الربط.
  3. علّم «نسخت المفتاح وحفظته في مكان آمن»، ثم اضغط «انتهيت».

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

تبديل المفتاح​

لكل مستخدم مفتاحان نشطان بحد أقصى، فتبدّل المفتاح والربط يعمل طوال الوقت:

  1. أنشئ المفتاح الجديد وانسخه.
  2. ضعه في النظام مكان القديم، وتأكد أن الربط يعمل.
  3. اسحب المفتاح القديم.

بلغت الحد؟ اسحب أحدهما أولاً ثم أنشئ بديله.

سحب المفتاح​

  1. في صفحة «مفاتيح API»، اضغط «اسحب» بجانب المفتاح.
  2. راجع آخر استخدام له في رسالة التأكيد، ثم اضغط «اسحب المفتاح».

يتوقف فوراً كل نظام يستخدم المفتاح. والمفتاح المسحوب يبقى في القائمة بحالة «مسحوب» للرجوع إليه، وسحبه نهائي. ولإعادة الربط أنشئ مفتاح جديد.

ما يقدر عليه الشريك بمفتاحك​

الشريك الذي يحمل مفتاحك:

  • يقرأ ما تقرؤه في المنصة: المنتجات والإدراجات، والطلبات، والمخزون، والمبيعات، والربحية والتسويات، وأوامر الشراء، وصحة البراند، وحالة المزامنة.
  • ينفّذ ما تسمح به صلاحياتك، مثل إجراءات تنفيذ الطلبات وتحديث الأسعار والكميات.
  • تصله إشعارات فورية (webhooks) عند تغيّر طلب أو مرتجع أو أمر شراء أو صحة براند.

وإنشاء المفاتيح وسحبها يبقى لك من المنصة.

أعطِ كل نظام أو شريك مفتاحه الخاص، لتسحب مفتاح أحدهم ويبقى الآخر يعمل.

للمطورين​

دليل المطورين ومرجع الواجهة وبيئة التجربة ببيانات نموذجية في developer.nasam.co. شارك الرابط مع من يبني الربط.

خطوتك التالية​

تحتاج مساعدة؟

فريق نَسَم معك أياً كان سؤالك: واتساب +966 55 009 0039 أو general@nasam.co. ودخولك إلى الأسواق نرتبه معك خطوة خطوة، والاستشارة مجانية.