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

ابدأ

NPM VersionBundle Size

OneEntry Platform SDK هو SDK يوفر وسيلة سهلة للتفاعل مع واجهة برمجة تطبيقات OneEntry Platform.

🚀 بدء سريع​

ابدأ العمل مع OneEntry في 3 خطوات بسيطة:

1️⃣ تثبيت الحزمة​

  npm install oneentry

2️⃣ تهيئة SDK​

  import { defineOneEntry } from 'oneentry';

  const api = defineOneEntry('your-project-url', {
    token: 'your-api-token',
    langCode: 'en_US'
  });

3️⃣ ابدأ باستخدام واجهة البرمجة​

  // جلب المنتجات 
  const products = await api.Products.getProducts({ limit: 10 });

  // الحصول على ملف تعريف المستخدم
  const user = await api.Users.getUser();

  // إرسال نموذج
  const formData = await api.FormData.postFormsData('contact-form', {
    name: 'جون دو',
    email: 'john@example.com'
  });

🎉 هذا كل شيء! أنت جاهز لبناء تطبيقات مذهلة مع OneEntry.

✨ الميزات الرئيسية​

🔐
مصادقة آمنة

إدارة رموز مدمجة ودعم OAuth

🌍
متعدد اللغات

دعم i18n مع اكتشاف اللغة التلقائي

📝
TypeScript

تعريفات نوع كاملة لتحسين تجربة المطور

⚡
خفيف الوزن

حجم حزمة محسّن للإنتاج

🔌
معمارية معيارية

24 وحدة متخصصة لتلبية جميع احتياجاتك

🛡️
معالجة الأخطاء

معالجات أخطاء مخصصة ووضع shell

🌐 الموارد​

📖 الاستخدام التفصيلي​

جميع الوحدات المتاحة​

استورد وفكك جميع الوحدات التي تحتاجها:


import { defineOneEntry } from 'oneentry'

const config = { 
  token: 'your-app-token', 
} 
const { 
  Admins, 
  AttributesSets, 
  AuthProvider, 
  Blocks, 
  Events, 
  FileUploading, 
  Forms, 
  FormData, 
  GeneralTypes, 
  ImmutableSettings, 
  IntegrationCollections, 
  Locales, 
  Menus, 
  Orders, 
  Pages, 
  Payments, 
  ProductStatuses, 
  Products, 
  Settings, 
  System, 
  Templates, 
  TemplatePreviews, 
  Users, 
  WS 
} = defineOneEntry('your-url', config);

أو

const config = {
  token: 'your-app-token',
};

const api = defineOneEntry('your-url', config);

التكوين​

المعلمة الثانية من المُنشئ تأخذ 'config'. تحتوي على القيم التالية:

  • 'token' - قم بتعيين مفتاح الرمز إذا كان مشروعك مؤمنًا بـ "رمز واجهة برمجة التطبيقات الأمنية". إذا كنت تستخدم حماية الشهادة، فلا تمرر هذه المتغير. يمكنك قراءة المزيد عن أمان مشروعك هنا.
  • 'langCode' - قم بتعيين "langCode" لتعيين اللغة الافتراضية. من خلال تحديد هذه المعلمة مرة واحدة، لن تحتاج إلى تمرير langCode إلى طرق واجهة برمجة التطبيقات ONEENTRY. إذا لم تقم بتمرير اللغة الافتراضية، فسيتم تعيينها إلى "en_US".
  • 'traficLimit' - تستخدم بعض الطرق أكثر من طلب واحد إلى OneEntry بحيث تكون البيانات التي تتلقاها كاملة وسهلة العمل معها. مرر القيمة "true" لهذه المعلمة لتوفير حركة المرور وقرر بنفسك ما هي البيانات التي تحتاجها. القيمة الافتراضية هي "false".
  • 'auth' - كائن بإعدادات التفويض. بشكل افتراضي، يتم تكوين SDK للعمل مع الرموز داخل جلسة المستخدم ولا يتطلب أي عمل إضافي منك. في نفس الوقت، لا يخزن SDK حالة الجلسة بين الجلسات. إذا كنت راضيًا عن هذه الإعدادات، فلا تمرر المتغير 'auth' على الإطلاق.

يحتوي 'auth' على الإعدادات التالية:

  • 'refreshToken' - رمز التحديث الخاص بالمستخدم. قم بنقله هنا من المستودع لاستعادة جلسة المستخدم أثناء التهيئة.
  • 'saveFunction' - دالة تعمل مع تحديث رمز التحديث. إذا كنت ترغب في تخزين الرمز بين الجلسات، على سبيل المثال في التخزين المحلي، مرر دالة هنا تقوم بذلك. يجب أن تقبل الدالة معلمة سيتم تمرير السلسلة التي تحتوي على الرمز إليها.
  • 'customAuth' - إذا كنت ترغب في تكوين التفويض والعمل مع الرموز بنفسك، قم بتعيين هذه العلامة إلى true. إذا كنت ترغب في استخدام إعدادات sdk، قم بتعيينها إلى false أو لا تمررها على الإطلاق.
  • 'providerMarker' - العلامة لمزود التفويض. الافتراضي: 'email'. مثال على تكوين مع حماية الرمز والمصادقة التلقائية التي تخزن الحالة بين الجلسات
const tokenFunction = (token) => {
  localStorage.setItem('refreshToken', token);
};

const api = defineOneEntry('https://my-project.oneentry.cloud', {
  token: 'my-token',
  langCode: 'en_US',
  auth: {
    refreshToken: localStorage.getItem('refreshToken'),
    saveFunction: tokenFunction,
    providerMarker: 'email'
  },
});

مثال على تكوين محمي بشهادة يسمح لك بتكوين نظام التفويض بنفسك ويحفظ البيانات على الطلبات.

const api = defineOneEntry('https://my-project.oneentry.cloud', {
  langCode: 'en_US',
  traficLimit: true,
  auth: {
    customAuth: true,
    refreshToken: localStorage.getItem('refreshToken'),
    providerMarker: 'email'
  },
});

إذا اخترت تكوين الرموز بنفسك، يمكنك تمرير الرمز إلى الطريقة كما يلي. تسمح لك الطريقة الوسيطة بتمرير رمز الوصول إلى الطلب. ثم استدعِ الطريقة المطلوبة. يجب عدم استدعاء هذه الطريقة (setAccessToken) إذا كانت الطريقة لا تتطلب مصادقة المستخدم.

const user = api.Users.setAccessToken('my.access.token').getUser();

إذا اخترت حماية الرمز لضمان أمان الاتصال، فقط مرر رمزك إلى الدالة كمعلمة اختيارية.

يمكنك الحصول على رمز كما يلي​

  1. قم بتسجيل الدخول إلى حسابك الشخصي
  2. انتقل إلى علامة التبويب "المشاريع" واختر مشروعًا
  3. انتقل إلى علامة التبويب "الوصول"
  4. قم بتعيين المفتاح إلى "رمز واجهة برمجة التطبيقات الأمنية"
  5. قم بتسجيل الدخول إلى المشروع، وانتقل إلى قسم الإعدادات وافتح علامة التبويب الخاصة بالرمز
  6. احصل على رمز مشروعك ونسخه

يمكنك أيضًا توصيل شهادة tls لحماية مشروعك. في هذه الحالة، لا تمرر "token" على الإطلاق. عند استخدام الشهادة، قم بإعداد وكيل في مشروعك. مرر سلسلة فارغة كمعلمة url. تعرف على المزيد حول الأمان

const saveTokenFromLocalStorage = (token) => {
  localStorage.setItem('refreshToken', token);
};

const api = defineOneEntry('your-url', {
  token: 'my-token',
  langCode: 'my-langCode',
  auth: {
    customAuth: false,
    userToken: 'rerfesh.token',
    saveFunction: saveTokenFromLocalStorage,
    providerMarker: 'email'
  },
});

الأخطاء​

إذا كنت ترغب في تخطي الأخطاء داخل sc، اترك خاصية "errors" كما هي بشكل افتراضي. في هذه الحالة، ستحصل إما على بيانات الكيان أو كائن الخطأ. تحتاج إلى إجراء تحقق من النوع. على سبيل المثال، من خلال التحقق من خاصية statusCode باستخدام ".hasOwnProperty"

ومع ذلك، إذا كنت ترغب في استخدام البناء "try catch(e) ", قم بتعيين الخاصية "isShell" إلى القيمة "false". في هذه الحالة، تحتاج إلى معالجة الخطأ باستخدام "try catch(e) ".

أيضًا، يمكنك تمرير دوال مخصصة سيتم استدعاؤها داخل sdk مع رمز الخطأ المناسب. تستقبل هذه الدوال كائن الخطأ كوسيط. يمكنك معالجته بنفسك.

const api = defineOneEntry('your-url', {
  token: 'my-token',
  langCode: 'my-langCode',
  errors: {
    isShell: false,
    customErrors: {
      400: (error) => console.error(error.message),
      404: (error) => console.error(error.message),
      500: (error) => console.error(error.message),
    },
  },
});

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

استكشف أدلتنا الشاملة لمعرفة المزيد: